class StateChange in Workbench Moderation Actions 8

Publishes a media entity.

Plugin annotation

@Action(
  id = "state_change",
  deriver =
  "Drupal\workbench_moderation_actions\Plugin\Deriver\StateChangeDeriver"
)

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\workbench_moderation_actions\Plugin\Action\StateChange implements ContainerFactoryPluginInterface

1 file declares its use of StateChange

DeriverTest.php in tests/src/Kernel/DeriverTest.php

Tests.

File

src/Plugin/Action/StateChange.php, line 25

Namespace

Drupal\workbench_moderation_actions\Plugin\Action

class StateChange extends ActionBase implements ContainerFactoryPluginInterface {

  /**
   * Provides workbench_moderation.moderation_information value.
   *
   * @var \Drupal\workbench_moderation\ModerationInformationInterface
   */
  protected $moderationInfo;

  /**
   * Provides workbench_moderation.state_transition_validation value.
   *
   * @var \Drupal\workbench_moderation\StateTransitionValidation
   */
  protected $validation;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModerationInformationInterface $mod_info, StateTransitionValidation $validation, EntityTypeManagerInterface $entityTypeManager, MessengerInterface $messenger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moderationInfo = $mod_info;
    $this->validation = $validation;
    $this->entityTypeManager = $entityTypeManager;
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('workbench_moderation.moderation_information'), $container
      ->get('workbench_moderation.state_transition_validation'), $container
      ->get('entity_type.manager'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ContentEntityInterface $entity = NULL) {
    if ($entity && !$this->moderationInfo
      ->isModeratableEntity($entity)) {
      $this->messenger
        ->addMessage($this
        ->t('One or more entities were skipped as they are under moderation and may not be directly published or unpublished.'));
      return;
    }

    /** @var \Drupal\Core\Entity\ContentEntityInterface $object */
    $original_entity = $entity;
    $entity = $this
      ->loadLatestRevision($entity);

    // Support the advanced_scheduler/scheduler modules.
    if ($original_entity->publish_on->value === NULL && !empty($entity->publish_on->value)) {
      $entity->publish_on->value = NULL;
    }
    $entity
      ->get('moderation_state')->target_id = $this->pluginDefinition['state'];
    $violations = $entity
      ->validate();
    if (($moderation_violations = $violations
      ->getByField('moderation_state')) && count($moderation_violations)) {

      /** @var \Symfony\Component\Validator\ConstraintViolation $violation */
      foreach ($moderation_violations as $violation) {
        $this->messenger
          ->addError($violation
          ->getMessage());
      }
      return;
    }
    $entity
      ->isDefaultRevision(TRUE);
    $entity
      ->save();
  }

  /**
   * Loads the latest revision of an entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   Content entity.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface
   *   The latest revision of an entity.
   */
  protected function loadLatestRevision(ContentEntityInterface $entity) {
    $original_entity = $this->moderationInfo
      ->getLatestRevision($entity
      ->getEntityTypeId(), $entity
      ->id());
    if (!$entity
      ->isDefaultTranslation() && $original_entity
      ->hasTranslation($entity
      ->language()
      ->getId())) {
      $original_entity = $original_entity
        ->getTranslation($entity
        ->language()
        ->getId());
    }
    return $original_entity;
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

    /** @var \Drupal\Core\Entity\ContentEntityInterface $object */
    $object = $this
      ->loadLatestRevision($object);
    $from = $object
      ->get('moderation_state')->target_id;
    $to = $this->pluginDefinition['state'];
    $result = AccessResult::allowedIf($this->validation
      ->userMayTransition($from, $to, $account));
    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	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	public	function	Gets the messenger.	29
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	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.
StateChange::$entityTypeManager	protected	property	The entity type manager.
StateChange::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
StateChange::$moderationInfo	protected	property	Provides workbench_moderation.moderation_information value.
StateChange::$validation	protected	property	Provides workbench_moderation.state_transition_validation value.
StateChange::access	public	function	Checks object access. Overrides ActionInterface::access
StateChange::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
StateChange::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
StateChange::loadLatestRevision	protected	function	Loads the latest revision of an entity.
StateChange::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.