class BasicExample

A basic example action that does nothing.

Plugin annotation


@Action(
  id = "action_example_basic_action",
  label = @Translation("Action Example: A basic example action that does nothing"),
  type = "system"
)

Hierarchy

  • class \Drupal\action_example\Plugin\Action\BasicExample implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Action\ActionBase

Expanded class hierarchy of BasicExample

File

View on git.drupalcode.org

modules/action_example/src/Plugin/Action/BasicExample.php, line 21

Namespace

Drupal\action_example\Plugin\Action
View source 
class BasicExample extends ActionBase implements ContainerFactoryPluginInterface {
  
  /**
   * Construct a BasicExample object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MessengerInterface $messenger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->setMessenger($messenger);
  }
  
  /**
   * {@inheritDoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('messenger'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function execute($object = NULL) {
    $this->messenger()
      ->addMessage($this->t('action_example_basic_action fired'));
  }
  
  /**
   * {@inheritDoc}
   */
  public function access($object, ?AccountInterface $account = NULL, $return_as_object = FALSE) {
    $result = AccessResult::allowed();
    return $return_as_object ? $result : $result->isAllowed();
  }

}

Members

Title Modifiers Object type Summary
BasicExample::access public function
BasicExample::create public static function
BasicExample::execute public function
BasicExample::__construct public function Construct a BasicExample object.