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

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