comment.views.inc in Views (for Drupal 7) 6.3
Same filename and directory in other branches
Provide views data and handlers for comment.module
File
modules/comment.views.incView source
<?php
/**
* @file
* Provide views data and handlers for comment.module
*/
/**
* @defgroup views_comment_module comment.module handlers
*
* Includes the tables 'comments' and 'node_comment_statistics'
* @{
*/
/**
* Implementation of hook_views_data()
*/
function comment_views_data() {
// Define the base group of this table. Fields that don't
// have a group defined will go into this field by default.
$data['comments']['table']['group'] = t('Comment');
$data['comments']['table']['base'] = array(
'field' => 'cid',
'title' => t('Comment'),
'help' => t("Comments are responses to node content."),
);
//joins
$data['comments']['table']['join'] = array(
//...to the node table
'node' => array(
'left_field' => 'nid',
'field' => 'nid',
),
);
// ----------------------------------------------------------------
// Fields
// subject
$data['comments']['subject'] = array(
'title' => t('Title'),
'help' => t('The title of the comment.'),
'field' => array(
'handler' => 'views_handler_field_comment',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// comment (the comment body)
$data['comments']['comment'] = array(
'title' => t('Body'),
'help' => t('The text of the comment.'),
'field' => array(
'handler' => 'views_handler_field_markup',
'format' => 'format',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
// cid
$data['comments']['cid'] = array(
'title' => t('ID'),
'help' => t('The comment ID of the field'),
'field' => array(
'handler' => 'views_handler_field_comment',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
),
);
// name (of comment author)
$data['comments']['name'] = array(
'title' => t('Author'),
'help' => t("The name of the comment's author. Can be rendered as a link to the author's homepage."),
'field' => array(
'handler' => 'views_handler_field_comment_username',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// homepage
$data['comments']['homepage'] = array(
'title' => t("Author's website"),
'help' => t("The website address of the comment's author. Can be rendered as a link. Will be empty if the author is a registered user."),
'field' => array(
'handler' => 'views_handler_field_url',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// hostname
$data['comments']['hostname'] = array(
'title' => t('Hostname'),
'help' => t('Hostname of user that posted the comment.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// mail
$data['comments']['mail'] = array(
'title' => t('Mail'),
'help' => t('Email of user that posted the comment. Will be empty if the author is a registered user.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// timestamp (when comment was posted)
$data['comments']['timestamp'] = array(
'title' => t('Post date'),
'help' => t('Date and time of when the comment was posted.'),
'field' => array(
'handler' => 'views_handler_field_date',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_date',
),
'filter' => array(
'handler' => 'views_handler_filter_date',
),
);
$data['comments']['timestamp_fulldate'] = array(
'title' => t('Created date'),
'help' => t('Date in the form of CCYYMMDD.'),
'argument' => array(
'field' => 'timestamp',
'handler' => 'views_handler_argument_node_created_fulldate',
),
);
$data['comments']['timestamp_year_month'] = array(
'title' => t('Created year + month'),
'help' => t('Date in the form of YYYYMM.'),
'argument' => array(
'field' => 'timestamp',
'handler' => 'views_handler_argument_node_created_year_month',
),
);
$data['comments']['timestamp_year'] = array(
'title' => t('Created year'),
'help' => t('Date in the form of YYYY.'),
'argument' => array(
'field' => 'timestamp',
'handler' => 'views_handler_argument_node_created_year',
),
);
$data['comments']['timestamp_month'] = array(
'title' => t('Created month'),
'help' => t('Date in the form of MM (01 - 12).'),
'argument' => array(
'field' => 'timestamp',
'handler' => 'views_handler_argument_node_created_month',
),
);
$data['comments']['timestamp_day'] = array(
'title' => t('Created day'),
'help' => t('Date in the form of DD (01 - 31).'),
'argument' => array(
'field' => 'timestamp',
'handler' => 'views_handler_argument_node_created_day',
),
);
$data['comments']['timestamp_week'] = array(
'title' => t('Created week'),
'help' => t('Date in the form of WW (01 - 53).'),
'argument' => array(
'field' => 'timestamp',
'handler' => 'views_handler_argument_node_created_week',
),
);
// status (approved or not)
$data['comments']['status'] = array(
'title' => t('In moderation'),
'help' => t('Whether or not the comment is currently in the moderation queue.'),
'field' => array(
'handler' => 'views_handler_field_boolean',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_boolean_operator',
'label' => t('In the moderation queue'),
'type' => 'yes-no',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
);
// link to view comment
$data['comments']['view_comment'] = array(
'field' => array(
'title' => t('View link'),
'help' => t('Provide a simple link to view the comment.'),
'handler' => 'views_handler_field_comment_link',
),
);
// link to edit comment
$data['comments']['edit_comment'] = array(
'field' => array(
'title' => t('Edit link'),
'help' => t('Provide a simple link to edit the comment.'),
'handler' => 'views_handler_field_comment_link_edit',
),
);
// link to delete comment
$data['comments']['delete_comment'] = array(
'field' => array(
'title' => t('Delete link'),
'help' => t('Provide a simple link to delete the comment.'),
'handler' => 'views_handler_field_comment_link_delete',
),
);
// link to reply to comment
$data['comments']['replyto_comment'] = array(
'field' => array(
'title' => t('Reply-to link'),
'help' => t('Provide a simple link to reply to the comment.'),
'handler' => 'views_handler_field_comment_link_reply',
),
);
$data['comments']['thread'] = array(
'field' => array(
'title' => t('Depth'),
'help' => t('Display the depth of the comment if it is threaded.'),
'handler' => 'views_handler_field_comment_depth',
),
'sort' => array(
'title' => t('Thread'),
'help' => t('Sort by the threaded order. This will keep child comments together with their parents.'),
'handler' => 'views_handler_sort_comment_thread',
),
);
$data['comments']['nid'] = array(
'title' => t('Nid'),
'help' => t('The node ID to which the comment is a reply to.'),
'relationship' => array(
'title' => t('Content'),
'help' => t('The content to which the comment is a reply to.'),
'base' => 'node',
'base field' => 'nid',
'handler' => 'views_handler_relationship',
'label' => t('Node'),
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
),
'field' => array(
'handler' => 'views_handler_field_numeric',
),
);
$data['comments']['uid'] = array(
'title' => t('Uid'),
'help' => t("The User ID of the comment's author."),
'relationship' => array(
'title' => t('User'),
'base' => 'users',
'base field' => 'uid',
'handler' => 'views_handler_relationship',
'label' => t('User'),
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
),
'field' => array(
'handler' => 'views_handler_filter_user_name',
),
);
$data['comments']['pid'] = array(
'title' => t('Parent CID'),
'help' => t('The Comment ID of the parent comment.'),
'field' => array(
'handler' => 'views_handler_field',
),
'relationship' => array(
'title' => t('Parent comment'),
'help' => t('The parent comment.'),
'base' => 'comments',
'base field' => 'cid',
'handler' => 'views_handler_relationship',
'label' => t('Parent comment'),
),
);
// ----------------------------------------------------------------------
// node_comment_statistics table
// define the group
$data['node_comment_statistics']['table']['group'] = t('Node');
// joins
$data['node_comment_statistics']['table']['join'] = array(
//...to the node table
'node' => array(
'type' => 'INNER',
'left_field' => 'nid',
'field' => 'nid',
),
);
// last_comment_timestamp
$data['node_comment_statistics']['last_comment_timestamp'] = array(
'title' => t('Last comment time'),
'help' => t('Date and time of when the last comment was posted.'),
'field' => array(
'handler' => 'views_handler_field_last_comment_timestamp',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_date',
),
'filter' => array(
'handler' => 'views_handler_filter_date',
),
);
// last_comment_name (author's name)
$data['node_comment_statistics']['last_comment_name'] = array(
'title' => t("Last comment author"),
'help' => t('The name of the author of the last posted comment.'),
'field' => array(
'handler' => 'views_handler_field_ncs_last_comment_name',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_ncs_last_comment_name',
),
);
// comment_count
$data['node_comment_statistics']['comment_count'] = array(
'title' => t('Comment count'),
'help' => t('The number of comments a node has.'),
'field' => array(
'handler' => 'views_handler_field_numeric',
'click sortable' => TRUE,
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'argument' => array(
'handler' => 'views_handler_argument',
),
);
// last_comment_timestamp
$data['node_comment_statistics']['last_updated'] = array(
'title' => t('Updated/commented date'),
'help' => t('The most recent of last comment posted or node updated time.'),
'field' => array(
'handler' => 'views_handler_field_ncs_last_updated',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_ncs_last_updated',
),
'filter' => array(
'handler' => 'views_handler_filter_ncs_last_updated',
),
);
// last_comment_uid
$data['node_comment_statistics']['last_comment_uid'] = array(
'title' => t('Last comment uid'),
'help' => t('The User ID of the author of the last comment of a node.'),
'relationship' => array(
'title' => t('Last comment author'),
'base' => 'users',
'base field' => 'uid',
'handler' => 'views_handler_relationship',
'label' => t('Last comment author'),
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
),
'field' => array(
'handler' => 'views_handler_filter_user_name',
),
);
return $data;
}
/**
* Use views_data_alter to add items to the node table that are
* relevant to comments.
*/
function comment_views_data_alter(&$data) {
// new comments
$data['node']['new_comments'] = array(
'title' => t('New comments'),
'help' => t('The number of new comments on the node.'),
'field' => array(
'handler' => 'views_handler_field_node_new_comments',
'no group by' => TRUE,
),
);
$data['node']['comments_link'] = array(
'field' => array(
'title' => t('Add comment link'),
'help' => t('Display the standard add comment link used on regular nodes, which will only display if the viewing user has access to add a comment.'),
'handler' => 'views_handler_field_comment_node_link',
),
);
// Comment status of the node
$data['node']['comment'] = array(
'title' => t('Comment status'),
'help' => t('Whether comments are enabled or disabled on the node.'),
'field' => array(
'handler' => 'views_handler_field_node_comment',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_node_comment',
),
);
$data['node']['uid_touch'] = array(
'title' => t('User posted or commented'),
'help' => t('Display nodes only if a user posted the node or commented on the node.'),
'argument' => array(
'field' => 'uid',
'name table' => 'users',
'name field' => 'name',
'handler' => 'views_handler_argument_comment_user_uid',
),
'filter' => array(
'field' => 'uid',
'name table' => 'users',
'name field' => 'name',
'handler' => 'views_handler_filter_comment_user_uid',
),
);
}
/**
* Implementation of hook_views_plugins
*/
function comment_views_plugins() {
return array(
'module' => 'views',
// This just tells views our themes are in Views.
'row' => array(
'comment' => array(
'title' => t('Comment'),
'help' => t('Display the comment with standard comment view.'),
'handler' => 'views_plugin_row_comment_view',
'path' => drupal_get_path('module', 'views') . '/modules/comment',
// not necessary for most modules
'theme' => 'views_view_row_comment',
'base' => array(
'comments',
),
// only works with 'comment' as base.
'uses options' => TRUE,
'type' => 'normal',
'help topic' => 'style-comment',
),
'comment_rss' => array(
'title' => t('Comment'),
'help' => t('Display the comment as RSS.'),
'handler' => 'views_plugin_row_comment_rss',
'path' => drupal_get_path('module', 'views') . '/modules/comment',
// not necessary for most modules
'theme' => 'views_view_row_rss',
'base' => array(
'comments',
),
// only works with 'comment' as base.
'type' => 'feed',
'help topic' => 'style-comment-rss',
),
),
);
}
/**
* Implementation of hook_views_handlers() to register all of the basic handlers
* views uses.
*/
function comment_views_handlers() {
return array(
'info' => array(
'path' => drupal_get_path('module', 'views') . '/modules/comment',
),
'handlers' => array(
'views_handler_field_comment' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_comment_username' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_comment_depth' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_comment_link' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_comment_link_edit' => array(
'parent' => 'views_handler_field_comment_link',
),
'views_handler_field_comment_link_delete' => array(
'parent' => 'views_handler_field_comment_link',
),
'views_handler_field_comment_link_reply' => array(
'parent' => 'views_handler_field_comment_link',
),
'views_handler_field_comment_node_link' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_ncs_last_comment_name' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_ncs_last_updated' => array(
'parent' => 'views_handler_field_date',
),
'views_handler_field_node_new_comments' => array(
'parent' => 'views_handler_field_numeric',
),
'views_handler_field_node_comment' => array(
'parent' => 'views_handler_field',
),
'views_handler_field_last_comment_timestamp' => array(
'parent' => 'views_handler_field_date',
),
// sort handlers
'views_handler_sort_comment_thread' => array(
'parent' => 'views_handler_sort',
),
'views_handler_sort_ncs_last_comment_name' => array(
'parent' => 'views_handler_sort',
),
'views_handler_sort_ncs_last_updated' => array(
'parent' => 'views_handler_sort_date',
),
// filter handlers
'views_handler_filter_ncs_last_updated' => array(
'parent' => 'views_handler_filter_date',
),
'views_handler_filter_node_comment' => array(
'parent' => 'views_handler_filter_in_operator',
),
'views_handler_filter_comment_user_uid' => array(
'parent' => 'views_handler_filter_user_name',
),
// argument handlers
'views_handler_argument_comment_user_uid' => array(
'parent' => 'views_handler_argument',
),
),
);
}
/**
* Template helper for theme_views_view_row_comment
*/
function template_preprocess_views_view_row_comment(&$vars) {
$options = $vars['options'];
$view =& $vars['view'];
$plugin =& $view->style_plugin->row_plugin;
$comment = $plugin->comments[$vars['row']->{$vars['field_alias']}];
$node = node_load($comment->nid);
// Put the view on the node so we can retrieve it in the preprocess.
$node->view =& $view;
$links = array();
if (!empty($options['links'])) {
$links = module_invoke_all('link', 'comment', $comment, 0);
drupal_alter('link', $links, $node);
}
$vars['comment'] = theme('comment_view', $comment, $node, $links);
}
/**
* @}
*/
Functions
Name | Description |
---|---|
comment_views_data | Implementation of hook_views_data() |
comment_views_data_alter | Use views_data_alter to add items to the node table that are relevant to comments. |
comment_views_handlers | Implementation of hook_views_handlers() to register all of the basic handlers views uses. |
comment_views_plugins | Implementation of hook_views_plugins |
template_preprocess_views_view_row_comment | Template helper for theme_views_view_row_comment |