You are here

Home » API reference » Zircon Profile 8 » CommentViewsData.php

class CommentViewsData in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/comment/src/CommentViewsData.php \Drupal\comment\CommentViewsData

Provides views data for the comment entity type.

Hierarchy

Expanded class hierarchy of CommentViewsData

File

core/modules/comment/src/CommentViewsData.php, line 15
Contains \Drupal\comment\CommentViewsData.

Namespace

Drupal\comment
View source 
class CommentViewsData extends EntityViewsData {

  /**
   * {@inheritdoc}
   */
  public function getViewsData() {
    $data = parent::getViewsData();
    $data['comment_field_data']['table']['base']['help'] = t('Comments are responses to content.');
    $data['comment_field_data']['table']['base']['access query tag'] = 'comment_access';
    $data['comment_field_data']['table']['wizard_id'] = 'comment';
    $data['comment_field_data']['subject']['title'] = t('Title');
    $data['comment_field_data']['subject']['help'] = t('The title of the comment.');
    $data['comment_field_data']['name']['title'] = t('Author');
    $data['comment_field_data']['name']['help'] = t("The name of the comment's author. Can be rendered as a link to the author's homepage.");
    $data['comment_field_data']['name']['field']['default_formatter'] = 'comment_username';
    $data['comment_field_data']['homepage']['title'] = t("Author's website");
    $data['comment_field_data']['homepage']['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.");
    $data['comment_field_data']['mail']['help'] = t('Email of user that posted the comment. Will be empty if the author is a registered user.');
    $data['comment_field_data']['created']['title'] = t('Post date');
    $data['comment_field_data']['created']['help'] = t('Date and time of when the comment was created.');
    $data['comment_field_data']['changed']['title'] = t('Updated date');
    $data['comment_field_data']['changed']['help'] = t('Date and time of when the comment was last updated.');
    $data['comment_field_data']['changed_fulldata'] = array(
      'title' => t('Created date'),
      'help' => t('Date in the form of CCYYMMDD.'),
      'argument' => array(
        'field' => 'changed',
        'id' => 'date_fulldate',
      ),
    );
    $data['comment_field_data']['changed_year_month'] = array(
      'title' => t('Created year + month'),
      'help' => t('Date in the form of YYYYMM.'),
      'argument' => array(
        'field' => 'changed',
        'id' => 'date_year_month',
      ),
    );
    $data['comment_field_data']['changed_year'] = array(
      'title' => t('Created year'),
      'help' => t('Date in the form of YYYY.'),
      'argument' => array(
        'field' => 'changed',
        'id' => 'date_year',
      ),
    );
    $data['comment_field_data']['changed_month'] = array(
      'title' => t('Created month'),
      'help' => t('Date in the form of MM (01 - 12).'),
      'argument' => array(
        'field' => 'changed',
        'id' => 'date_month',
      ),
    );
    $data['comment_field_data']['changed_day'] = array(
      'title' => t('Created day'),
      'help' => t('Date in the form of DD (01 - 31).'),
      'argument' => array(
        'field' => 'changed',
        'id' => 'date_day',
      ),
    );
    $data['comment_field_data']['changed_week'] = array(
      'title' => t('Created week'),
      'help' => t('Date in the form of WW (01 - 53).'),
      'argument' => array(
        'field' => 'changed',
        'id' => 'date_week',
      ),
    );
    $data['comment_field_data']['status']['title'] = t('Approved status');
    $data['comment_field_data']['status']['help'] = t('Whether the comment is approved (or still in the moderation queue).');
    $data['comment_field_data']['status']['filter']['label'] = t('Approved comment status');
    $data['comment_field_data']['status']['filter']['type'] = 'yes-no';
    $data['comment']['approve_comment'] = array(
      'field' => array(
        'title' => t('Link to approve comment'),
        'help' => t('Provide a simple link to approve the comment.'),
        'id' => 'comment_link_approve',
      ),
    );
    $data['comment']['replyto_comment'] = array(
      'field' => array(
        'title' => t('Link to reply-to comment'),
        'help' => t('Provide a simple link to reply to the comment.'),
        'id' => 'comment_link_reply',
      ),
    );
    $data['comment_field_data']['thread']['field'] = array(
      'title' => t('Depth'),
      'help' => t('Display the depth of the comment if it is threaded.'),
      'id' => 'comment_depth',
    );
    $data['comment_field_data']['thread']['sort'] = array(
      'title' => t('Thread'),
      'help' => t('Sort by the threaded order. This will keep child comments together with their parents.'),
      'id' => 'comment_thread',
    );
    unset($data['comment_field_data']['thread']['filter']);
    unset($data['comment_field_data']['thread']['argument']);
    $entities_types = \Drupal::entityManager()
      ->getDefinitions();

    // Provide a relationship for each entity type except comment.
    foreach ($entities_types as $type => $entity_type) {
      if ($type == 'comment' || !$entity_type
        ->isSubclassOf('\\Drupal\\Core\\Entity\\ContentEntityInterface') || !$entity_type
        ->getBaseTable()) {
        continue;
      }
      if ($fields = \Drupal::service('comment.manager')
        ->getFields($type)) {
        $data['comment_field_data'][$type] = array(
          'relationship' => array(
            'title' => $entity_type
              ->getLabel(),
            'help' => t('The @entity_type to which the comment is a reply to.', array(
              '@entity_type' => $entity_type
                ->getLabel(),
            )),
            'base' => $entity_type
              ->getDataTable() ?: $entity_type
              ->getBaseTable(),
            'base field' => $entity_type
              ->getKey('id'),
            'relationship field' => 'entity_id',
            'id' => 'standard',
            'label' => $entity_type
              ->getLabel(),
            'extra' => array(
              array(
                'field' => 'entity_type',
                'value' => $type,
                'table' => 'comment_field_data',
              ),
            ),
          ),
        );
      }
    }
    $data['comment_field_data']['uid']['title'] = t('Author uid');
    $data['comment_field_data']['uid']['help'] = t('If you need more fields than the uid add the comment: author relationship');
    $data['comment_field_data']['uid']['relationship']['title'] = t('Author');
    $data['comment_field_data']['uid']['relationship']['help'] = t("The User ID of the comment's author.");
    $data['comment_field_data']['uid']['relationship']['label'] = t('author');
    $data['comment_field_data']['pid']['title'] = t('Parent CID');
    $data['comment_field_data']['pid']['relationship']['title'] = t('Parent comment');
    $data['comment_field_data']['pid']['relationship']['help'] = t('The parent comment');
    $data['comment_field_data']['pid']['relationship']['label'] = t('parent');

    // Define the base group of this table. Fields that don't have a group defined
    // will go into this field by default.
    $data['comment_entity_statistics']['table']['group'] = t('Comment Statistics');

    // Provide a relationship for each entity type except comment.
    foreach ($entities_types as $type => $entity_type) {
      if ($type == 'comment' || !$entity_type
        ->isSubclassOf('\\Drupal\\Core\\Entity\\ContentEntityInterface') || !$entity_type
        ->getBaseTable()) {
        continue;
      }

      // This relationship does not use the 'field id' column, if the entity has
      // multiple comment-fields, then this might introduce duplicates, in which
      // case the site-builder should enable aggregation and SUM the comment_count
      // field. We cannot create a relationship from the base table to
      // {comment_entity_statistics} for each field as multiple joins between
      // the same two tables is not supported.
      if (\Drupal::service('comment.manager')
        ->getFields($type)) {
        $data['comment_entity_statistics']['table']['join'][$entity_type
          ->getDataTable() ?: $entity_type
          ->getBaseTable()] = array(
          'type' => 'INNER',
          'left_field' => $entity_type
            ->getKey('id'),
          'field' => 'entity_id',
          'extra' => array(
            array(
              'field' => 'entity_type',
              'value' => $type,
            ),
          ),
        );
      }
    }
    $data['comment_entity_statistics']['last_comment_timestamp'] = array(
      'title' => t('Last comment time'),
      'help' => t('Date and time of when the last comment was posted.'),
      'field' => array(
        'id' => 'comment_last_timestamp',
      ),
      'sort' => array(
        'id' => 'date',
      ),
      'filter' => array(
        'id' => 'date',
      ),
    );
    $data['comment_entity_statistics']['last_comment_name'] = array(
      'title' => t("Last comment author"),
      'help' => t('The name of the author of the last posted comment.'),
      'field' => array(
        'id' => 'comment_ces_last_comment_name',
        'no group by' => TRUE,
      ),
      'sort' => array(
        'id' => 'comment_ces_last_comment_name',
        'no group by' => TRUE,
      ),
    );
    $data['comment_entity_statistics']['comment_count'] = array(
      'title' => t('Comment count'),
      'help' => t('The number of comments an entity has.'),
      'field' => array(
        'id' => 'numeric',
      ),
      'filter' => array(
        'id' => 'numeric',
      ),
      'sort' => array(
        'id' => 'standard',
      ),
      'argument' => array(
        'id' => 'standard',
      ),
    );
    $data['comment_entity_statistics']['last_updated'] = array(
      'title' => t('Updated/commented date'),
      'help' => t('The most recent of last comment posted or entity updated time.'),
      'field' => array(
        'id' => 'comment_ces_last_updated',
        'no group by' => TRUE,
      ),
      'sort' => array(
        'id' => 'comment_ces_last_updated',
        'no group by' => TRUE,
      ),
      'filter' => array(
        'id' => 'comment_ces_last_updated',
      ),
    );
    $data['comment_entity_statistics']['cid'] = array(
      'title' => t('Last comment CID'),
      'help' => t('Display the last comment of an entity'),
      'relationship' => array(
        'title' => t('Last comment'),
        'help' => t('The last comment of an entity.'),
        'group' => t('Comment'),
        'base' => 'comment',
        'base field' => 'cid',
        'id' => 'standard',
        'label' => t('Last Comment'),
      ),
    );
    $data['comment_entity_statistics']['last_comment_uid'] = array(
      'title' => t('Last comment uid'),
      'help' => t('The User ID of the author of the last comment of an entity.'),
      'relationship' => array(
        'title' => t('Last comment author'),
        'base' => 'users',
        'base field' => 'uid',
        'id' => 'standard',
        'label' => t('Last comment author'),
      ),
      'filter' => array(
        'id' => 'numeric',
      ),
      'argument' => array(
        'id' => 'numeric',
      ),
      'field' => array(
        'id' => 'numeric',
      ),
    );
    $data['comment_entity_statistics']['entity_type'] = array(
      'title' => t('Entity type'),
      'help' => t('The entity type to which the comment is a reply to.'),
      'field' => array(
        'id' => 'standard',
      ),
      'filter' => array(
        'id' => 'string',
      ),
      'argument' => array(
        'id' => 'string',
      ),
      'sort' => array(
        'id' => 'standard',
      ),
    );
    $data['comment_entity_statistics']['field_name'] = array(
      'title' => t('Comment field name'),
      'help' => t('The field name from which the comment originated.'),
      'field' => array(
        'id' => 'standard',
      ),
      'filter' => array(
        'id' => 'string',
      ),
      'argument' => array(
        'id' => 'string',
      ),
      'sort' => array(
        'id' => 'standard',
      ),
    );
    return $data;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommentViewsData::getViewsData public function Returns views data for the entity type. Overrides EntityViewsData::getViewsData
EntityViewsData::$entityType protected property Entity type for this views controller instance.
EntityViewsData::$fieldStorageDefinitions protected property The field storage definitions for all base fields of the entity type.
EntityViewsData::$moduleHandler protected property The module handler.
EntityViewsData::$storage protected property The storage used for this entity type.
EntityViewsData::$translationManager protected property The translation manager.
EntityViewsData::addEntityLinks protected function Sets the entity links in case corresponding link templates exist.
EntityViewsData::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
EntityViewsData::getFieldStorageDefinitions protected function Gets the field storage definitions.
EntityViewsData::getViewsTableForEntityType public function Gets the table of an entity type to be used as base table in views. Overrides EntityViewsDataInterface::getViewsTableForEntityType
EntityViewsData::mapFieldDefinition protected function Puts the views data for a single field onto the views data.
EntityViewsData::mapSingleFieldViewsData protected function Provides the views data for a given data type and schema field.
EntityViewsData::processViewsDataForEntityReference protected function Processes the views data for an entity reference field.
EntityViewsData::processViewsDataForLanguage protected function Processes the views data for a language field.
EntityViewsData::processViewsDataForTextLong protected function Processes the views data for a text field with formatting.
EntityViewsData::processViewsDataForUuid protected function Processes the views data for a UUID field.
EntityViewsData::__construct function Constructs an EntityViewsData object.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.