You are here

class ModerationOptOutPublishNode in Workbench Moderation 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Action/ModerationOptOutPublishNode.php \Drupal\workbench_moderation\Plugin\Action\ModerationOptOutPublishNode

Alternate action plugin that knows to opt-out of modifying moderated entites.

Hierarchy

Expanded class hierarchy of ModerationOptOutPublishNode

See also

PublishAction

1 file declares its use of ModerationOptOutPublishNode
workbench_moderation.module in ./workbench_moderation.module
Contains workbench_moderation.module.

File

src/Plugin/Action/ModerationOptOutPublishNode.php, line 18

Namespace

Drupal\workbench_moderation\Plugin\Action
View source
class ModerationOptOutPublishNode extends PublishAction implements ContainerFactoryPluginInterface {

  /**
   * Moderation information.
   *
   * @var \Drupal\workbench_moderation\ModerationInformationInterface
   */
  protected $moderationInfo;

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

  /**
   * {@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('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute($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;
    }
    parent::execute($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $result = parent::access($object, $account, TRUE)
      ->andif(AccessResult::forbiddenIf($this->moderationInfo
      ->isModeratableEntity($object))
      ->addCacheableDependency($object));
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

}

Members

Namesort descending 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
EntityActionBase::$entityTypeManager protected property The entity type manager.
EntityActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ModerationOptOutPublishNode::$moderationInfo protected property Moderation information.
ModerationOptOutPublishNode::access public function Checks object access. Overrides PublishAction::access
ModerationOptOutPublishNode::create public static function Creates an instance of the plugin. Overrides EntityActionBase::create
ModerationOptOutPublishNode::execute public function Executes the plugin. Overrides PublishAction::execute
ModerationOptOutPublishNode::__construct public function Constructs a EntityActionBase object. Overrides EntityActionBase::__construct
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.
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.