ViewsData.php

Same filename in this branch
  1. 8.9.x core/modules/views/src/ViewsData.php
Same filename in other branches
  1. 9 core/modules/content_moderation/src/ViewsData.php
  2. 9 core/modules/views/src/ViewsData.php
  3. 10 core/modules/content_moderation/src/ViewsData.php
  4. 10 core/modules/views/src/ViewsData.php
  5. 11.x core/modules/content_moderation/src/ViewsData.php
  6. 11.x core/modules/views/src/ViewsData.php

Namespace

Drupal\content_moderation

File

core/modules/content_moderation/src/ViewsData.php

View source
<?php

namespace Drupal\content_moderation;

use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;

/**
 * Provides the content_moderation views integration.
 *
 * @internal
 */
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);
        });
        // Provides a relationship from moderated entity to its moderation state
        // entity.
        $content_moderation_state_entity_type = $this->entityTypeManager
            ->getDefinition('content_moderation_state');
        $content_moderation_state_entity_base_table = $content_moderation_state_entity_type->getDataTable() ?: $content_moderation_state_entity_type->getBaseTable();
        $content_moderation_state_entity_revision_base_table = $content_moderation_state_entity_type->getRevisionDataTable() ?: $content_moderation_state_entity_type->getRevisionTable();
        foreach ($entity_types_with_moderation as $entity_type_id => $entity_type) {
            $table = $entity_type->getDataTable() ?: $entity_type->getBaseTable();
            $data[$table]['moderation_state'] = [
                'title' => t('Moderation state'),
                'relationship' => [
                    'id' => 'standard',
                    'title' => $this->t('Deprecated: @label moderation state', [
                        '@label' => $entity_type->getLabel(),
                    ]),
                    'help' => $this->t('Using a relationship to the Content Moderation State entity type has been deprecated and will be removed before 9.0.0. See <a target="_blank" href=":url">this change record</a> for alternatives.', [
                        ':url' => 'https://www.drupal.org/node/3061099',
                    ]),
                    'base' => $content_moderation_state_entity_base_table,
                    'base field' => 'content_entity_id',
                    'relationship field' => $entity_type->getKey('id'),
                    'extra' => [
                        [
                            'field' => 'content_entity_type_id',
                            'value' => $entity_type_id,
                        ],
                    ],
                    'deprecated' => 'Moderation state relationships are deprecated in drupal:8.8.0 and is removed in drupal:9.0.0. See https://www.drupal.org/node/3061099',
                ],
                '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'),
                'relationship' => [
                    'id' => 'standard',
                    'title' => $this->t('Deprecated: @label moderation state', [
                        '@label' => $entity_type->getLabel(),
                    ]),
                    'help' => $this->t('Using a relationship to the Content Moderation State entity type has been deprecated and will be removed before 9.0.0. See <a target="_blank" href=":url">this change record</a> for alternatives.', [
                        ':url' => 'https://www.drupal.org/node/3061099',
                    ]),
                    'base' => $content_moderation_state_entity_revision_base_table,
                    'base field' => 'content_entity_revision_id',
                    'relationship field' => $entity_type->getKey('revision'),
                    'extra' => [
                        [
                            'field' => 'content_entity_type_id',
                            'value' => $entity_type_id,
                        ],
                    ],
                    'deprecated' => 'Moderation state relationships are deprecated in drupal:8.8.0 and is removed in drupal:9.0.0. See https://www.drupal.org/node/3061099',
                ],
                '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;
    }

}

Classes

Title Deprecated Summary
ViewsData Provides the content_moderation views integration.

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