class views_plugin_row_comment_view in Views (for Drupal 7) 7.3

Plugin which performs a comment_view on the resulting object.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_row
      • class \views_plugin_row_comment_view

1 string reference to 'views_plugin_row_comment_view'

comment_views_plugins in modules/comment.views.inc

Implements hook_views_plugins().

File

modules/comment/views_plugin_row_comment_view.inc, line 11

Definition of views_plugin_row_comment_view.

class views_plugin_row_comment_view extends views_plugin_row {

  /**
   * {@inheritdoc}
   */
  public $base_field = 'cid';

  /**
   * {@inheritdoc}
   */
  public $base_table = 'comment';

  /**
   * Stores all comments which are preloaded.
   */
  public $comments = array();

  /**
   * Stores all nodes of all comments which are preloaded.
   */
  public $nodes = array();

  /**
   * {@inheritdoc}
   */
  public function summary_title() {
    return t('Settings');
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['links'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    $options['view_mode'] = array(
      'default' => 'full',
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $options = $this
      ->options_form_summary_options();
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => $options,
      '#title' => t('View mode'),
      '#default_value' => $this->options['view_mode'],
    );
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
  }

  /**
   * Return the main options, which are shown in the summary title.
   */
  public function options_form_summary_options() {
    $entity_info = entity_get_info('comment');
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    if (empty($options)) {
      $options = array(
        'full' => t('Full content'),
      );
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function pre_render($result) {
    $cids = array();
    foreach ($result as $row) {
      $cids[] = $row->cid;
    }

    // Load all comments.
    $cresult = comment_load_multiple($cids);
    $nids = array();
    foreach ($cresult as $comment) {
      $comment->depth = count(explode('.', $comment->thread)) - 1;
      $this->comments[$comment->cid] = $comment;
      $nids[] = $comment->nid;
    }

    // Load all nodes of the comments.
    $nodes = node_load_multiple(array_unique($nids));
    foreach ($nodes as $node) {
      $this->nodes[$node->nid] = $node;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_row::init	public	function		2
views_plugin_row::options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_plugin::options_submit	1
views_plugin_row::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::render	public	function	Render a row object. This usually passes through to a theme template of some form, but not always.	7
views_plugin_row::uses_fields	public	function
views_plugin_row_comment_view::$base_field	public	property
views_plugin_row_comment_view::$base_table	public	property
views_plugin_row_comment_view::$comments	public	property	Stores all comments which are preloaded.
views_plugin_row_comment_view::$nodes	public	property	Stores all nodes of all comments which are preloaded.
views_plugin_row_comment_view::options_form	public	function	Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_comment_view::options_form_summary_options	public	function	Return the main options, which are shown in the summary title.
views_plugin_row_comment_view::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition
views_plugin_row_comment_view::pre_render	public	function	Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
views_plugin_row_comment_view::summary_title	public	function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title