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

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