vendor/pimcore/pimcore/lib/Workflow/EventSubscriber/ChangePublishedStateSubscriber.php line 37

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Workflow\EventSubscriber;
  18. use Pimcore\Model\DataObject\Concrete;
  19. use Pimcore\Model\Document;
  20. use Pimcore\Workflow\Transition;
  21. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  22. use Symfony\Component\Workflow\Event\Event;
  24. /**
  25.  * @internal
  26.  */
  27. class ChangePublishedStateSubscriber implements EventSubscriberInterface
  28. {
  29.     const NO_CHANGE = 'no_change';
  31.     const FORCE_PUBLISHED = 'force_published';
  33.     const FORCE_UNPUBLISHED = 'force_unpublished';
  35.     const SAVE_VERSION = 'save_version';
  37.     public function onWorkflowCompleted(Event $event)
  38.     {
  39.         if (!$this->checkEvent($event)) {
  40.             return;
  41.         }
  43.         /** @var Transition $transition */
  44.         $transition = $event->getTransition();
  46.         /** @var Document|Concrete $subject */
  47.         $subject = $event->getSubject();
  49.         $changePublishedState = $transition->getChangePublishedState();
  51.         if ($changePublishedState === self::FORCE_UNPUBLISHED) {
  52.             $subject->setPublished(false);
  53.         } elseif ($changePublishedState === self::FORCE_PUBLISHED) {
  54.             $subject->setPublished(true);
  55.         }
  56.     }
  58.     /**
  59.      * check's if the event subscriber should be executed
  60.      *
  61.      * @param Event $event
  62.      *
  63.      * @return bool
  64.      */
  65.     private function checkEvent(Event $event): bool
  66.     {
  67.         return $event->getTransition() instanceof Transition
  68.             && ($event->getSubject() instanceof Concrete || $event->getSubject() instanceof Document);
  69.     }
  71.     public static function getSubscribedEvents(): array
  72.     {
  73.         return [
  74.             'workflow.completed' => 'onWorkflowCompleted',
  75.         ];
  76.     }
  77. }