class AssetGroup in farmOS 2.x
Same name in this branch
- 2.x modules/asset/group/src/Plugin/Action/AssetGroup.php \Drupal\farm_group\Plugin\Action\AssetGroup
- 2.x modules/asset/group/src/Plugin/views/field/AssetGroup.php \Drupal\farm_group\Plugin\views\field\AssetGroup
Action that groups assets with an observation log.
Plugin annotation
@Action(
id = "asset_group_action",
label = @Translation("Assign assets to a group with an observation log."),
type = "asset",
confirm_form_route_name = "farm_group.asset_group_action_form"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Action\ActionBase implements ActionInterface
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase implements DependentPluginInterface, ContainerFactoryPluginInterface
- class \Drupal\farm_group\Plugin\Action\AssetGroup
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase implements DependentPluginInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Action\ActionBase implements ActionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of AssetGroup
File
- modules/
asset/ group/ src/ Plugin/ Action/ AssetGroup.php, line 21
Namespace
Drupal\farm_group\Plugin\ActionView source
class AssetGroup extends EntityActionBase {
/**
* The tempstore object.
*
* @var \Drupal\Core\TempStore\SharedTempStore
*/
protected $tempStore;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* Constructs a new AssetGroup 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\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
* The tempstore factory.
* @param \Drupal\Core\Session\AccountInterface $current_user
* Current user.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, PrivateTempStoreFactory $temp_store_factory, AccountInterface $current_user) {
$this->currentUser = $current_user;
$this->tempStore = $temp_store_factory
->get('asset_group_confirm');
parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager);
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager'), $container
->get('tempstore.private'), $container
->get('current_user'));
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
// Add dependency on farm_observation for observation logs.
$dependencies['module'][] = 'farm_observation';
return $dependencies;
}
/**
* {@inheritdoc}
*/
public function executeMultiple(array $entities) {
/** @var \Drupal\Core\Entity\EntityInterface[] $entities */
$this->tempStore
->set($this->currentUser
->id(), $entities);
}
/**
* {@inheritdoc}
*/
public function execute($object = NULL) {
$this
->executeMultiple([
$object,
]);
}
/**
* {@inheritdoc}
*/
public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
return $object
->access('update', $account, $return_as_object);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssetGroup:: |
protected | property | The current user. | |
AssetGroup:: |
protected | property | The tempstore object. | |
AssetGroup:: |
public | function |
Checks object access. Overrides ActionInterface:: |
|
AssetGroup:: |
public | function |
Calculates dependencies for the configured plugin. Overrides EntityActionBase:: |
|
AssetGroup:: |
public static | function |
Creates an instance of the plugin. Overrides EntityActionBase:: |
|
AssetGroup:: |
public | function |
Executes the plugin. Overrides ExecutableInterface:: |
|
AssetGroup:: |
public | function |
Executes the plugin for an array of objects. Overrides ActionBase:: |
|
AssetGroup:: |
public | function |
Constructs a new AssetGroup object. Overrides EntityActionBase:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityActionBase:: |
protected | property | The entity type manager. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |