EntityPathAliasCreateDeriver.php in Rules 8.3

Namespace

Drupal\rules\Plugin\RulesAction

File

src/Plugin/RulesAction/EntityPathAliasCreateDeriver.php

<?php

namespace Drupal\rules\Plugin\RulesAction;

use Drupal\Component\Plugin\Derivative\DeriverBase;
use Drupal\Core\Entity\ContentEntityTypeInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\rules\Context\ContextDefinition;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Derives entity create plugin definitions based on content entity types.
 *
 * @see \Drupal\rules\Plugin\RulesAction\EntityPathAliasCreate
 */
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;
  }

}

Classes

Name	Description
EntityPathAliasCreateDeriver	Derives entity create plugin definitions based on content entity types.