class Action in Zircon Profile 8
Same name in this branch
- 8 core/lib/Drupal/Core/Annotation/Action.php \Drupal\Core\Annotation\Action
- 8 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
- 8 core/modules/action/src/Plugin/migrate/source/d6/Action.php \Drupal\action\Plugin\migrate\source\d6\Action
Same name and namespace in other branches
- 8.0 core/modules/system/src/Entity/Action.php \Drupal\system\Entity\Action
Defines the configured action entity.
Plugin annotation
@ConfigEntityType(
id = "action",
label = @Translation("Action"),
admin_permission = "administer actions",
entity_keys = {
"id" = "id",
"label" = "label"
},
config_export = {
"id",
"label",
"type",
"plugin",
"configuration",
}
)
Hierarchy
- class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
- class \Drupal\system\Entity\Action implements EntityWithPluginCollectionInterface, ActionConfigEntityInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
Expanded class hierarchy of Action
2 files declare their use of Action
- ConfigInstallProfileOverrideTest.php in core/
modules/ config/ src/ Tests/ ConfigInstallProfileOverrideTest.php - Contains \Drupal\config\Tests\ConfigInstallProfileOverrideTest.
- UnpublishByKeywordActionTest.php in core/
modules/ node/ tests/ src/ Kernel/ Action/ UnpublishByKeywordActionTest.php - Contains \Drupal\Tests\node\Kernel\Action\UnpublishByKeywordActionTest.
3 string references to 'Action'
- ActionAdminManageForm::buildForm in core/
modules/ action/ src/ Form/ ActionAdminManageForm.php - Form constructor.
- CommentAdminOverview::buildForm in core/
modules/ comment/ src/ Form/ CommentAdminOverview.php - Form constructor for the comment overview administration form.
- core.data_types.schema.yml in core/
config/ schema/ core.data_types.schema.yml - core/config/schema/core.data_types.schema.yml
File
- core/
modules/ system/ src/ Entity/ Action.php, line 37 - Contains \Drupal\system\Entity\Action.
Namespace
Drupal\system\EntityView source
class Action extends ConfigEntityBase implements ActionConfigEntityInterface, EntityWithPluginCollectionInterface {
/**
* The name (plugin ID) of the action.
*
* @var string
*/
protected $id;
/**
* The label of the action.
*
* @var string
*/
protected $label;
/**
* The action type.
*
* @var string
*/
protected $type;
/**
* The configuration of the action.
*
* @var array
*/
protected $configuration = array();
/**
* The plugin ID of the action.
*
* @var string
*/
protected $plugin;
/**
* The plugin collection that stores action plugins.
*
* @var \Drupal\Core\Action\ActionPluginCollection
*/
protected $pluginCollection;
/**
* Encapsulates the creation of the action's LazyPluginCollection.
*
* @return \Drupal\Component\Plugin\LazyPluginCollection
* The action's plugin collection.
*/
protected function getPluginCollection() {
if (!$this->pluginCollection) {
$this->pluginCollection = new ActionPluginCollection(\Drupal::service('plugin.manager.action'), $this->plugin, $this->configuration);
}
return $this->pluginCollection;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return array(
'configuration' => $this
->getPluginCollection(),
);
}
/**
* {@inheritdoc}
*/
public function getPlugin() {
return $this
->getPluginCollection()
->get($this->plugin);
}
/**
* {@inheritdoc}
*/
public function setPlugin($plugin_id) {
$this->plugin = $plugin_id;
$this
->getPluginCollection()
->addInstanceId($plugin_id);
}
/**
* {@inheritdoc}
*/
public function getPluginDefinition() {
return $this
->getPlugin()
->getPluginDefinition();
}
/**
* {@inheritdoc}
*/
public function execute(array $entities) {
return $this
->getPlugin()
->executeMultiple($entities);
}
/**
* {@inheritdoc}
*/
public function isConfigurable() {
return $this
->getPlugin() instanceof ConfigurablePluginInterface;
}
/**
* {@inheritdoc}
*/
public function getType() {
return $this->type;
}
/**
* {@inheritdoc}
*/
public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
/** @var \Drupal\system\ActionConfigEntityInterface $a */
/** @var \Drupal\system\ActionConfigEntityInterface $b */
$a_type = $a
->getType();
$b_type = $b
->getType();
if ($a_type != $b_type) {
return strnatcasecmp($a_type, $b_type);
}
return parent::sort($a, $b);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Action:: |
protected | property | The configuration of the action. | |
Action:: |
protected | property | The name (plugin ID) of the action. | |
Action:: |
protected | property | The label of the action. | |
Action:: |
protected | property | The plugin ID of the action. | |
Action:: |
protected | property | The plugin collection that stores action plugins. | |
Action:: |
protected | property | The action type. | |
Action:: |
public | function | ||
Action:: |
public | function |
Returns the operation plugin. Overrides ActionConfigEntityInterface:: |
|
Action:: |
protected | function | Encapsulates the creation of the action's LazyPluginCollection. | |
Action:: |
public | function |
Gets the plugin collections used by this entity. Overrides EntityWithPluginCollectionInterface:: |
|
Action:: |
public | function | ||
Action:: |
public | function |
Returns the operation type. Overrides ActionConfigEntityInterface:: |
|
Action:: |
public | function |
Returns whether or not this action is configurable. Overrides ActionConfigEntityInterface:: |
|
Action:: |
public | function | ||
Action:: |
public static | function |
Helper callback for uasort() to sort configuration entities by weight and label. Overrides ConfigEntityBase:: |
|
ConfigEntityBase:: |
private | property | Whether the config is being created, updated or deleted through the import process. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The name of the property that is used to store plugin configuration. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 2 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
12 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides Entity:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides Entity:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides Entity:: |
7 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides Entity:: |
12 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides Entity:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the status of the isSyncing flag. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides Entity:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides Entity:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides Entity:: |
10 |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | 1 |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
Entity:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
Entity:: |
protected | property | The entity type. | |
Entity:: |
protected | property | A typed data object wrapping this entity. | |
Entity:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
Entity:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets the entity manager. | |
Entity:: |
protected | function | Gets the entity type manager. | |
Entity:: |
public | function |
The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
Entity:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
5 |
Entity:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets the language manager. | |
Entity:: |
protected | function | Gets an array link templates. | 1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Acts on an entity after it is created but before hooks are invoked. Overrides EntityInterface:: |
4 |
Entity:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
14 |
Entity:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
20 |
Entity:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
6 |
Entity:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets an array of placeholders for this entity. | 1 |
Entity:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets the UUID generator. | |
Entity:: |
public | function | 5 | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
RefinableCacheableDependencyTrait:: |
protected | property | Cache contexts. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache max-age. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache tags. | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function |