class FieldUpdateActionBase
Same name in other branches
- 9 core/lib/Drupal/Core/Field/FieldUpdateActionBase.php \Drupal\Core\Field\FieldUpdateActionBase
- 8.9.x core/lib/Drupal/Core/Field/FieldUpdateActionBase.php \Drupal\Core\Field\FieldUpdateActionBase
- 11.x core/lib/Drupal/Core/Field/FieldUpdateActionBase.php \Drupal\Core\Field\FieldUpdateActionBase
Provides a base for action plugins that update one or more fields.
Example implementation:
class PromoteAndMakeSticky extends FieldUpdateActionBase {
protected function getFieldsToUpdate() {
return [
'status' => NODE_PROMOTED,
'sticky' => NODE_STICKY,
];
}
}Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Field\FieldUpdateActionBase extends \Drupal\Core\Action\ActionBase
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of FieldUpdateActionBase
See also
\Drupal\Core\Action\Plugin\Action\PublishAction
4 files declare their use of FieldUpdateActionBase
- DemoteNode.php in core/
modules/ node/ src/ Plugin/ Action/ DemoteNode.php - PromoteNode.php in core/
modules/ node/ src/ Plugin/ Action/ PromoteNode.php - StickyNode.php in core/
modules/ node/ src/ Plugin/ Action/ StickyNode.php - UnstickyNode.php in core/
modules/ node/ src/ Plugin/ Action/ UnstickyNode.php
File
-
core/
lib/ Drupal/ Core/ Field/ FieldUpdateActionBase.php, line 28
Namespace
Drupal\Core\FieldView source
abstract class FieldUpdateActionBase extends ActionBase {
/**
* Gets an array of values to be set.
*
* @return array
* Array of values with field names as keys.
*/
protected abstract function getFieldsToUpdate();
/**
* {@inheritdoc}
*/
public function execute($entity = NULL) {
foreach ($this->getFieldsToUpdate() as $field => $value) {
$entity->{$field} = $value;
}
$entity->save();
}
/**
* {@inheritdoc}
*/
public function access($object, ?AccountInterface $account = NULL, $return_as_object = FALSE) {
/** @var \Drupal\Core\Access\AccessResultInterface $result */
$result = $object->access('update', $account, TRUE);
foreach ($this->getFieldsToUpdate() as $field => $value) {
$result->andIf($object->{$field}
->access('edit', $account, TRUE));
}
return $return_as_object ? $result : $result->isAllowed();
}
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| ActionBase::executeMultiple | public | function | Executes the plugin for an array of objects. | Overrides ActionInterface::executeMultiple | 3 |
| FieldUpdateActionBase::access | public | function | Checks object access. | Overrides ActionInterface::access | |
| FieldUpdateActionBase::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute | |
| FieldUpdateActionBase::getFieldsToUpdate | abstract protected | function | Gets an array of values to be set. | 4 | |
| PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
| PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.