class CommentRow

Plugin which performs a comment_view on the resulting object.

Plugin annotation


@Plugin(
  id = "comment",
  module = "comment",
  title = @Translation("Comment"),
  help = @Translation("Display the comment with standard comment view."),
  theme = "views_view_row_comment",
  base = {"comment"},
  entity_type = "comment",
  type = "normal"
)

Hierarchy

Expanded class hierarchy of CommentRow

File

drupal/core/modules/comment/lib/Drupal/comment/Plugin/views/row/CommentRow.php, line 28
Definition of Drupal\comment\Plugin\views\row\CommentRow.

Namespace

Drupal\comment\Plugin\views\row
View source
class CommentRow extends EntityRow {

  /**
   * Overrides Drupal\system\Plugin\views\row\Entity::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['links'] = array(
      'default' => TRUE,
    );
    $options['view_mode']['default'] = 'full';
    return $options;
  }

  /**
   * Overrides Drupal\system\Plugin\views\row\Entity::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
  }

  /**
   * Overrides Drupal\system\Plugin\views\row\Entity::render().
   */
  function render($row) {
    $entity_id = $row->{$this->field_alias};
    $build = $this->build[$entity_id];
    if (!$this->options['links']) {
      unset($build['links']);
    }
    return drupal_render($build);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommentRow::buildOptionsForm public function Overrides Drupal\system\Plugin\views\row\Entity::buildOptionsForm(). Overrides EntityRow::buildOptionsForm
CommentRow::defineOptions protected function Overrides Drupal\system\Plugin\views\row\Entity::defineOptions(). Overrides EntityRow::defineOptions
CommentRow::render function Overrides Drupal\system\Plugin\views\row\Entity::render(). Overrides EntityRow::render
EntityRow::$base_field public property The actual field which is used for the entity id.
EntityRow::$base_table public property The table the entity is using for storage.
EntityRow::$build protected property Contains an array of render arrays, one for each rendered entity.
EntityRow::$entityInfo protected property Contains the entity info of the entity type of this row plugin instance.
EntityRow::$entityType protected property Stores the entity type of the result entities.
EntityRow::buildViewModeOptions protected function Return the main options, which are shown in the summary title.
EntityRow::init public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::init(). Overrides RowPluginBase::init
EntityRow::pre_render public function Overrides Drupal\views\Plugin\views\row\RowPluginBase::pre_render(). Overrides RowPluginBase::pre_render
EntityRow::summaryTitle public function Overrides Drupal\views\Plugin\views\PluginBase::summaryTitle(). Overrides PluginBase::summaryTitle
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to it's output. 2
RowPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query
RowPluginBase::submitOptionsForm 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 PluginBase::submitOptionsForm 1
RowPluginBase::usesFields function Returns the usesFields property. 2
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm