class EntityFlagActionDeriver in Flag 8.4

Generate flag/unflag action plugins for each flag.

Hierarchy

• class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
  • class \Drupal\flag\Plugin\Derivative\EntityFlagActionDeriver implements ContainerDeriverInterface uses StringTranslationTrait

File

src/Plugin/Derivative/EntityFlagActionDeriver.php, line 14

Namespace

Drupal\flag\Plugin\Derivative

class EntityFlagActionDeriver extends DeriverBase implements ContainerDeriverInterface {
  use StringTranslationTrait;

  /**
   * The flag service.
   *
   * @var \Drupal\flag\FlagServiceInterface
   */
  protected $flagService;

  /**
   * Constructs the flag action deriver.
   *
   * @param \Drupal\flag\FlagServiceInterface $flag_service
   *   The flag service.
   */
  public function __construct(FlagServiceInterface $flag_service) {
    $this->flagService = $flag_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static($container
      ->get('flag'));
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeDefinitions($base_plugin_definition) {
    foreach ($this->flagService
      ->getAllFlags() as $flag_id => $flag) {
      foreach ([
        'flag',
        'unflag',
      ] as $action) {
        $this->derivatives[$flag_id . '_' . $action] = [
          'id' => $flag_id . '_' . $action,
          'label' => $flag
            ->getShortText($action),
          'type' => $flag
            ->getFlaggableEntityTypeId(),
        ] + $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
EntityFlagActionDeriver::$flagService	protected	property	The flag service.
EntityFlagActionDeriver::create	public static	function	Creates a new class instance. Overrides ContainerDeriverInterface::create
EntityFlagActionDeriver::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
EntityFlagActionDeriver::__construct	public	function	Constructs the flag action deriver.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.