class BulkUpdateFieldsActionBase in Bulk Update Fields 8

Update Fields.

Plugin annotation

@Action(
  id = "bulk_update_fields_action_base",
  label = "Bulk Update Fields to Another Value",
  type = "node",
  confirm_form_route_name = "bulk_update_fields.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\bulk_update_fields\Plugin\Action\BulkUpdateFieldsActionBase implements ContainerFactoryPluginInterface

File

src/Plugin/Action/BulkUpdateFieldsActionBase.php, line 22

Namespace

Drupal\bulk_update_fields\Plugin\Action

class BulkUpdateFieldsActionBase extends ActionBase implements ContainerFactoryPluginInterface {

  /**
   * The plugin_id.
   *
   * @var pluginId
   */
  protected $pluginId;

  /**
   * The plugin implementation definition.
   *
   * @var pluginDefinition
   */
  protected $pluginDefinition;

  /**
   * Configuration information passed into the plugin.
   *
   * When using an interface like
   * \Drupal\Component\Plugin\ConfigurablePluginInterface, this is where the
   * configuration should be stored.
   *
   * Plugin configuration is optional, so plugin implementations must provide
   * their own setters and getters.
   *
   * @var configuration
   */
  protected $configuration;

  /**
   * The tempstore factory.
   *
   * @var tempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * Session.
   *
   * @var sessionManager
   */
  private $sessionManager;

  /**
   * User.
   *
   * @var currentUser
   */
  private $currentUser;

  /**
   * Constructs a BulkUpdateFields 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\user\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Session\SessionManagerInterface $session_manager
   *   The session.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The session.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PrivateTempStoreFactory $temp_store_factory, SessionManagerInterface $session_manager, AccountInterface $current_user) {
    $this->configuration = $configuration;
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
    $this->tempStoreFactory = $temp_store_factory;
    $this->sessionManager = $session_manager;
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('user.private_tempstore'), $container
      ->get('session_manager'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    $ids = [];
    foreach ($entities as $entity) {
      $ids[$entity
        ->id()] = $entity;
    }
    $this->tempStoreFactory
      ->get('bulk_update_fields_ids')
      ->set($this->currentUser
      ->id(), $ids);
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ContentEntityInterface $entity = NULL) {
    $this
      ->executeMultiple([
      $entity,
    ]);
  }

  /**
   * {@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
BulkUpdateFieldsActionBase::$configuration	protected	property	Configuration information passed into the plugin. Overrides PluginBase::$configuration
BulkUpdateFieldsActionBase::$currentUser	private	property	User.
BulkUpdateFieldsActionBase::$pluginDefinition	protected	property	The plugin implementation definition. Overrides PluginBase::$pluginDefinition
BulkUpdateFieldsActionBase::$pluginId	protected	property	The plugin_id. Overrides PluginBase::$pluginId
BulkUpdateFieldsActionBase::$sessionManager	private	property	Session.
BulkUpdateFieldsActionBase::$tempStoreFactory	protected	property	The tempstore factory.
BulkUpdateFieldsActionBase::access	public	function	Checks object access. Overrides ActionInterface::access
BulkUpdateFieldsActionBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BulkUpdateFieldsActionBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
BulkUpdateFieldsActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
BulkUpdateFieldsActionBase::__construct	public	function	Constructs a BulkUpdateFields object. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	3
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.