ModerationOptOutUnpublish.php

Same filename in other branches
  1. 9 core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php
  2. 10 core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php
  3. 11.x core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php

Namespace

Drupal\content_moderation\Plugin\Action

File

core/modules/content_moderation/src/Plugin/Action/ModerationOptOutUnpublish.php

View source
<?php

namespace Drupal\content_moderation\Plugin\Action;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Action\Plugin\Action\UnpublishAction;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\content_moderation\ModerationInformationInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Alternate action plugin that can opt-out of modifying moderated entities.
 *
 * @see \Drupal\Core\Action\Plugin\Action\UnpublishAction
 */
class ModerationOptOutUnpublish extends UnpublishAction implements ContainerFactoryPluginInterface {
    
    /**
     * 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);
    }

}

Classes

Title Deprecated Summary
ModerationOptOutUnpublish Alternate action plugin that can opt-out of modifying moderated entities.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.