class Action

Same name in this branch
  1. 8.x drupal/core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
  2. 8.x drupal/core/modules/system/lib/Drupal/system/Plugin/Core/Entity/Action.php \Drupal\system\Plugin\Core\Entity\Action

Defines an Action annotation object.

Hierarchy

Expanded class hierarchy of Action

See also

\Drupal\Core\Action\ActionInterface

\Drupal\Core\Action\ActionManager

24 files declare their use of Action
AddRoleUser.php in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/AddRoleUser.php
Contains \Drupal\user\Plugin\Action\AddRoleUser.
AssignOwnerNode.php in drupal/core/modules/node/lib/Drupal/node/Plugin/Action/AssignOwnerNode.php
Contains \Drupal\node\Plugin\Action\AssignOwnerNode.
BlockUser.php in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/BlockUser.php
Contains \Drupal\user\Plugin\Action\BlockUser.
CancelUser.php in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/CancelUser.php
Contains \Drupal\user\Plugin\Action\CancelUser.
DeleteNode.php in drupal/core/modules/node/lib/Drupal/node/Plugin/Action/DeleteNode.php
Contains \Drupal\node\Plugin\Action\DeleteNode.

... See full list

7 string references to 'Action'
ActionAdminManageForm::buildForm in drupal/core/modules/action/lib/Drupal/action/Form/ActionAdminManageForm.php
Form constructor.
ActionManager::__construct in drupal/core/lib/Drupal/Core/Action/ActionManager.php
Constructs a ActionManager object.
ActionUnitTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Action/ActionUnitTest.php
action_views_data in drupal/core/modules/action/action.views.inc
Implements hook_views_data().
BulkFormTest::getInfo in drupal/core/modules/action/lib/Drupal/action/Tests/BulkFormTest.php

... See full list

24 classes are annotated with Action
AddRoleUser in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/AddRoleUser.php
Adds a role to a user.
AssignOwnerNode in drupal/core/modules/node/lib/Drupal/node/Plugin/Action/AssignOwnerNode.php
Assigns ownership of a node to a user.
BlockUser in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/BlockUser.php
Blocks a user.
CancelUser in drupal/core/modules/user/lib/Drupal/user/Plugin/Action/CancelUser.php
Cancels a user account.
DeleteNode in drupal/core/modules/node/lib/Drupal/node/Plugin/Action/DeleteNode.php
Redirects to a node deletion form.

... See full list

File

drupal/core/lib/Drupal/Core/Annotation/Action.php, line 20
Contains \Drupal\Core\Annotation\Action.

Namespace

Drupal\Core\Annotation
View source
class Action extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the action plugin.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The path for a confirmation form for this action.
   *
   * @todo Change this to accept a route.
   * @todo Provide a more generic way to allow an action to be confirmed first.
   *
   * @var string (optional)
   */
  public $confirm_form_path = '';

  /**
   * The entity type the action can apply to.
   *
   * @todo Replace with \Drupal\Core\Plugin\Context\Context.
   *
   * @var string
   */
  public $type = '';

}

Members

Namesort descending Modifiers Type Description Overrides
Action::$confirm_form_path public property The path for a confirmation form for this action.
Action::$id public property The plugin ID.
Action::$label public property The human-readable name of the action plugin.
Action::$type public property The entity type the action can apply to.
Plugin::$definition protected property The plugin definiton read from the class annotation.
Plugin::get public function Implements Drupal\Core\Annotation\AnnotationInterface::get(). Overrides AnnotationInterface::get
Plugin::parse protected function Parses an annotation into its definition.
Plugin::__construct public function Constructs a Plugin object.