abstract class FieldUpdateActionBase in Drupal 9

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 DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\Core\Field\FieldUpdateActionBase

See also

\Drupal\node\Plugin\Action\PublishNode

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\Field

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

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	3
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.