class ModerationOptOutUnpublish
Same name in other branches
- 8.9.x core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php \Drupal\content_moderation\Plugin\Action\ModerationOptOutUnpublish
- 10 core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php \Drupal\content_moderation\Plugin\Action\ModerationOptOutUnpublish
- 11.x core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php \Drupal\content_moderation\Plugin\Action\ModerationOptOutUnpublish
Alternate action plugin that can opt-out of modifying moderated entities.
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\Action\Plugin\Action\EntityActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Action\Plugin\Action\UnpublishAction extends \Drupal\Core\Action\Plugin\Action\EntityActionBase
- class \Drupal\content_moderation\Plugin\Action\ModerationOptOutUnpublish extends \Drupal\Core\Action\Plugin\Action\UnpublishAction
- class \Drupal\Core\Action\Plugin\Action\UnpublishAction extends \Drupal\Core\Action\Plugin\Action\EntityActionBase
- class \Drupal\Core\Action\Plugin\Action\EntityActionBase extends \Drupal\Core\Action\ActionBase implements \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- 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 ModerationOptOutUnpublish
See also
\Drupal\Core\Action\Plugin\Action\UnpublishAction
1 file declares its use of ModerationOptOutUnpublish
- content_moderation.module in core/
modules/ content_moderation/ content_moderation.module - Contains content_moderation.module.
File
-
core/
modules/ content_moderation/ src/ Plugin/ Action/ ModerationOptOutUnpublish.php, line 19
Namespace
Drupal\content_moderation\Plugin\ActionView source
class ModerationOptOutUnpublish extends UnpublishAction {
/**
* Moderation information service.
*
* @var \Drupal\content_moderation\ModerationInformationInterface
*/
protected $moderationInfo;
/**
* Bundle info service.
*
* @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
*/
protected $bundleInfo;
/**
* Messenger service.
*
* @var \Drupal\Core\Messenger\MessengerInterface
*/
protected $messenger;
/**
* ModerationOptOutUnpublish constructor.
*
* @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\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\content_moderation\ModerationInformationInterface $moderation_info
* The moderation information service.
* @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_info
* Bundle info service.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* Messenger service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ModerationInformationInterface $moderation_info, EntityTypeBundleInfoInterface $bundle_info, MessengerInterface $messenger) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager);
$this->moderationInfo = $moderation_info;
$this->bundleInfo = $bundle_info;
$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('entity_type.manager'), $container->get('content_moderation.moderation_information'), $container->get('entity_type.bundle.info'), $container->get('messenger'));
}
/**
* {@inheritdoc}
*/
public function access($entity, AccountInterface $account = NULL, $return_as_object = FALSE) {
/** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
if ($entity && $this->moderationInfo
->isModeratedEntity($entity)) {
$bundle_info = $this->bundleInfo
->getBundleInfo($entity->getEntityTypeId());
$bundle_label = $bundle_info[$entity->bundle()]['label'];
$this->messenger
->addWarning($this->t("@bundle @label were skipped as they are under moderation and may not be directly unpublished.", [
'@bundle' => $bundle_label,
'@label' => $entity->getEntityType()
->getPluralLabel(),
]));
$result = AccessResult::forbidden('Cannot directly unpublish moderated entities.');
return $return_as_object ? $result : $result->isAllowed();
}
return parent::access($entity, $account, $return_as_object);
}
}
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 |
EntityActionBase::$entityTypeManager | protected | property | The entity type manager. | ||
EntityActionBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
ModerationOptOutUnpublish::$bundleInfo | protected | property | Bundle info service. | ||
ModerationOptOutUnpublish::$messenger | protected | property | Messenger service. | ||
ModerationOptOutUnpublish::$moderationInfo | protected | property | Moderation information service. | ||
ModerationOptOutUnpublish::access | public | function | Checks object access. | Overrides UnpublishAction::access | |
ModerationOptOutUnpublish::create | public static | function | Creates an instance of the plugin. | Overrides EntityActionBase::create | |
ModerationOptOutUnpublish::__construct | public | function | ModerationOptOutUnpublish constructor. | Overrides EntityActionBase::__construct | |
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 | |
UnpublishAction::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.