class ViewsData

Provides the content_moderation views integration.

@internal

Hierarchy

Expanded class hierarchy of ViewsData

1 file declares its use of ViewsData
content_moderation.views.inc in core/modules/content_moderation/content_moderation.views.inc
Provide views data for content_moderation.module.
2 string references to 'ViewsData'
ViewsDataTest::setupMockedModuleHandler in core/modules/views/tests/src/Unit/ViewsDataTest.php
Mocks the basic module handler used for the test.
ViewsDataTest::testFullAndTableGetCache in core/modules/views/tests/src/Unit/ViewsDataTest.php
Tests the cache of the full and single table data.

File

View on git.drupalcode.org

core/modules/content_moderation/src/ViewsData.php, line 14

Namespace

Drupal\content_moderation
View source 
class ViewsData {
  use StringTranslationTrait;
  
  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  
  /**
   * The moderation information.
   *
   * @var \Drupal\content_moderation\ModerationInformationInterface
   */
  protected $moderationInformation;
  
  /**
   * Creates a new ViewsData instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\content_moderation\ModerationInformationInterface $moderation_information
   *   The moderation information.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ModerationInformationInterface $moderation_information) {
    $this->entityTypeManager = $entity_type_manager;
    $this->moderationInformation = $moderation_information;
  }
  
  /**
   * Returns the views data.
   *
   * @return array
   *   The views data.
   */
  public function getViewsData() {
    $data = [];
    $entity_types_with_moderation = array_filter($this->entityTypeManager
      ->getDefinitions(), function (EntityTypeInterface $type) {
      return $this->moderationInformation
        ->isModeratedEntityType($type);
    });
    foreach ($entity_types_with_moderation as $entity_type) {
      $table = $entity_type->getDataTable() ?: $entity_type->getBaseTable();
      $data[$table]['moderation_state'] = [
        'title' => t('Moderation state'),
        'field' => [
          'id' => 'moderation_state_field',
          'default_formatter' => 'content_moderation_state',
          'field_name' => 'moderation_state',
        ],
        'filter' => [
          'id' => 'moderation_state_filter',
          'allow empty' => TRUE,
        ],
        'sort' => [
          'id' => 'moderation_state_sort',
        ],
      ];
      $revision_table = $entity_type->getRevisionDataTable() ?: $entity_type->getRevisionTable();
      $data[$revision_table]['moderation_state'] = [
        'title' => t('Moderation state'),
        'field' => [
          'id' => 'moderation_state_field',
          'default_formatter' => 'content_moderation_state',
          'field_name' => 'moderation_state',
        ],
        'filter' => [
          'id' => 'moderation_state_filter',
          'allow empty' => TRUE,
        ],
        'sort' => [
          'id' => 'moderation_state_sort',
        ],
      ];
    }
    return $data;
  }

}

Members

Title Modifiers Object type Summary Overrides
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
ViewsData::$entityTypeManager protected property The entity type manager.
ViewsData::$moderationInformation protected property The moderation information.
ViewsData::getViewsData public function Returns the views data.
ViewsData::__construct public function Creates a new ViewsData instance.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.