class EntityPathAliasCreateDeriver

Derives entity create plugin definitions based on content entity types.

Hierarchy

Expanded class hierarchy of EntityPathAliasCreateDeriver

See also

\Drupal\rules\Plugin\RulesAction\EntityPathAliasCreate

File

src/Plugin/RulesAction/EntityPathAliasCreateDeriver.php, line 19

Namespace

Drupal\rules\Plugin\RulesAction
View source
class EntityPathAliasCreateDeriver extends DeriverBase implements ContainerDeriverInterface {
    use StringTranslationTrait;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Creates a new EntityPathAliasCreateDeriver 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:{$entity_type_id}"] = [
                'label' => $this->t('Create a @entity_type path alias', [
                    '@entity_type' => $entity_type->getSingularLabel(),
                ]),
                'category' => $this->t('Path'),
                'provider' => 'path_alias',
                'entity_type_id' => $entity_type_id,
                'context_definitions' => [
                    'entity' => ContextDefinition::create("entity:{$entity_type_id}")->setLabel($entity_type->getLabel())
                        ->setRequired(TRUE)
                        ->setDescription($this->t('The @entity_type for which to create a path alias.', [
                        '@entity_type' => $entity_type->getSingularLabel(),
                    ])),
                    'alias' => ContextDefinition::create('string')->setLabel($this->t('Path alias'))
                        ->setRequired(TRUE)
                        ->setDescription($this->t("Specify an alternative path by which the content can be accessed. For example, '/about' for an about page. Use an absolute path and do not add a trailing slash.")),
                ],
                'provides' => [],
            ] + $base_plugin_definition;
        }
        return $this->derivatives;
    }

}

Members

Title Sort descending 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
EntityPathAliasCreateDeriver::$entityTypeManager protected property The entity type manager.
EntityPathAliasCreateDeriver::create public static function Creates a new class instance. Overrides ContainerDeriverInterface::create
EntityPathAliasCreateDeriver::getDerivativeDefinitions public function Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
EntityPathAliasCreateDeriver::__construct public function Creates a new EntityPathAliasCreateDeriver 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.