/sites/all/modules/views/modules/comment.views.inc
Pascal | 499 lines | 33 code | 7 blank | 459 comment | 2 complexity | c0adfbf14fe77092fceb8448d72f8b26 MD5 | raw file
Possible License(s): LGPL-2.1
- <?php
- // $Id: comment.views.inc,v 1.22 2008/09/11 22:47:42 merlinofchaos Exp $
- /**
- * @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',
- ),
- );
- // name (of comment author)
- $data['comments']['name'] = array(
- 'title' => t('Author'),
- 'help' => t('The name of the poster.'),
- '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 a link. The homepage can also be linked with the Name field. Will be empty if posted by 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',
- ),
- );
- // 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',
- ),
- );
- // status (approved or not)
- $data['comments']['status'] = array(
- 'title' => t('In moderation'),
- 'help' => t('Whether or not the comment is currently in moderation.'),
- 'field' => array(
- 'handler' => 'views_handler_field_boolean',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'handler' => 'views_handler_filter_boolean_operator',
- 'label' => t('Moderated'),
- ),
- '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('Node'),
- 'help' => t('The node the comment is a reply to.'),
- 'relationship' => array(
- 'base' => 'node',
- 'field' => 'nid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('Node'),
- ),
- );
- $data['comments']['uid'] = array(
- 'title' => t('User'),
- 'help' => t('The user who wrote the comment.'),
- 'relationship' => array(
- 'base' => 'users',
- 'field' => 'uid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('User'),
- ),
- );
- $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',
- '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(
- '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_date',
- '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',
- ),
- );
- 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',
- ),
- );
- // 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 comments 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',
- ),
- );
- }
- /**
- * 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
- '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_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',
- ),
- // 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_ncs_last_updated' => array(
- 'parent' => 'views_handler_filter_in_operator',
- ),
- // argument handlers
- 'views_handler_filter_node_comment' => 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']->cid];
- $node = node_load($comment->nid);
- $links = '';
- 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);
- }
- /**
- * @}
- */