class LocalTasks in RNG - Events and Registrations 8

Provides dynamic tasks for RNG.

Hierarchy

• class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
  • class \Drupal\rng\Plugin\Derivative\LocalTasks implements ContainerDeriverInterface

1 string reference to 'LocalTasks'

rng.links.task.yml in ./rng.links.task.yml

rng.links.task.yml

File

src/Plugin/Derivative/LocalTasks.php, line 16

Namespace

Drupal\rng\Plugin\Derivative

class LocalTasks extends DeriverBase implements ContainerDeriverInterface {

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

  /**
   * The RNG event manager.
   *
   * @var \Drupal\rng\EventManagerInterface
   */
  protected $eventManager;

  /**
   * Constructs a LocalTasks object.
   *
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
   *   The route provider.
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   */
  public function __construct(EntityManagerInterface $entity_manager, RouteProviderInterface $route_provider, EventManagerInterface $event_manager) {
    $this->entityManager = $entity_manager;
    $this->routeProvider = $route_provider;
    $this->eventManager = $event_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static($container
      ->get('entity.manager'), $container
      ->get('router.route_provider'), $container
      ->get('rng.event_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeDefinitions($base_plugin_definition) {
    $this->derivatives = [];

    /** @var \Drupal\rng\Entity\EventType[] $event_types */
    foreach ($this->eventManager
      ->getEventTypes() as $entity_type => $event_types) {
      $cache_tags = $this->entityManager
        ->getDefinition($entity_type)
        ->getListCacheTags();
      foreach ($event_types as $event_type) {
        $cache_tags = Cache::mergeTags($cache_tags, $event_type
          ->getCacheTags());
      }

      // Only need one set of tasks task per entity type.
      if ($this->routeProvider
        ->getRouteByName("entity.{$entity_type}.canonical")) {
        $event_default = "rng.event.{$entity_type}.event.default";
        $this->derivatives[$event_default] = array(
          'title' => t('Event', [], [
            'context' => 'rng',
          ]),
          'base_route' => "entity.{$entity_type}.canonical",
          'route_name' => "rng.event.{$entity_type}.event",
          'weight' => 30,
          'cache_tags' => $cache_tags,
        );
        $this->derivatives["rng.event.{$entity_type}.register.type_list"] = [
          'route_name' => "rng.event.{$entity_type}.register.type_list",
          'base_route' => "entity.{$entity_type}.canonical",
          'title' => t('Register', [], [
            'context' => 'rng',
          ]),
          'weight' => 40,
          'cache_tags' => $cache_tags,
        ];
        $this->derivatives["rng.event.{$entity_type}.register"] = [
          'route_name' => "rng.event.{$entity_type}.register",
          'parent_id' => 'rng.local_tasks:' . "rng.event.{$entity_type}.register.type_list",
          'title' => t('Register', [], [
            'context' => 'rng',
          ]),
          'weight' => 40,
          'cache_tags' => $cache_tags,
        ];
        $this->derivatives["rng.event.{$entity_type}.event.settings"] = array(
          'title' => t('Settings'),
          'route_name' => $this->derivatives[$event_default]['route_name'],
          'parent_id' => 'rng.local_tasks:' . $event_default,
          'weight' => -100,
          'cache_tags' => $cache_tags,
        );
        $this->derivatives["rng.event.{$entity_type}.event.access"] = array(
          'title' => t('Access'),
          'route_name' => "rng.event.{$entity_type}.access",
          'parent_id' => 'rng.local_tasks:' . $event_default,
          'weight' => -80,
          'cache_tags' => $cache_tags,
        );
        $this->derivatives["rng.event.{$entity_type}.event.messages"] = array(
          'title' => t('Messages'),
          'route_name' => "rng.event.{$entity_type}.messages",
          'parent_id' => 'rng.local_tasks:' . $event_default,
          'weight' => 100,
          'cache_tags' => $cache_tags,
        );
        $this->derivatives["rng.event.{$entity_type}.event.group.list"] = array(
          'title' => t('Groups', [], [
            'context' => 'rng',
          ]),
          'route_name' => "rng.event.{$entity_type}.group.list",
          'parent_id' => 'rng.local_tasks:' . $event_default,
          'weight' => 150,
          'cache_tags' => $cache_tags,
        );
      }
    }
    foreach ($this->derivatives as &$entry) {
      $entry += $base_plugin_definition;
    }
    return parent::getDerivativeDefinitions($base_plugin_definition);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DeriverBase::$derivatives	protected	property	List of derivative definitions.	1
DeriverBase::getDerivativeDefinition	public	function	Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition
LocalTasks::$entityManager	protected	property	The entity manager.
LocalTasks::$eventManager	protected	property	The RNG event manager.
LocalTasks::$routeProvider	protected	property	The route provider.
LocalTasks::create	public static	function	Creates a new class instance. Overrides ContainerDeriverInterface::create
LocalTasks::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
LocalTasks::__construct	public	function	Constructs a LocalTasks object.