class EntityViewDeriver

Derives entity view plugin definitions based on content entity types.

Hierarchy

Expanded class hierarchy of EntityViewDeriver

1 string reference to 'EntityViewDeriver'
rules.rules.events.yml in ./rules.rules.events.yml
rules.rules.events.yml

File

src/Plugin/RulesEvent/EntityViewDeriver.php, line 16

Namespace

Drupal\rules\Plugin\RulesEvent
View source 
class EntityViewDeriver extends DeriverBase implements ContainerDeriverInterface {
    use StringTranslationTrait;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Creates a new EntityViewDeriver object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
     *   The string translation service.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation) {
        $this->entityTypeManager = $entity_type_manager;
        $this->stringTranslation = $string_translation;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, $base_plugin_id) {
        return new static($container->get('entity_type.manager'), $container->get('string_translation'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDerivativeDefinitions($base_plugin_definition) {
        foreach ($this->entityTypeManager
            ->getDefinitions() as $entity_type_id => $entity_type) {
            // Only allow content entities and ignore configuration entities.
            if (!$entity_type instanceof ContentEntityTypeInterface) {
                continue;
            }
            $this->derivatives[$entity_type_id] = [
                'label' => $this->t('Entity of type @entity_type is viewed', [
                    '@entity_type' => $entity_type->getSingularLabel(),
                ]),
                'category' => $entity_type->getLabel(),
                'entity_type_id' => $entity_type_id,
                'context_definitions' => [
                    $entity_type_id => [
                        'type' => "entity:{$entity_type_id}",
                        'label' => $entity_type->getLabel(),
                    ],
                ],
            ] + $base_plugin_definition;
        }
        return $this->derivatives;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DeriverBase::$derivatives protected property List of derivative definitions. 1
DeriverBase::getDerivativeDefinition public function Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition
EntityViewDeriver::$entityTypeManager protected property The entity type manager.
EntityViewDeriver::create public static function Creates a new class instance. Overrides ContainerDeriverInterface::create
EntityViewDeriver::getDerivativeDefinitions public function Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
EntityViewDeriver::__construct public function Creates a new EntityViewDeriver object.
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.