[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2020 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE
   8   */
   9  
  10  namespace Joomla\CMS\Event\Workflow;
  11  
  12  use BadMethodCallException;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Event class for Workflow Functionality Used events
  20   *
  21   * @since  4.0.0
  22   */
  23  class WorkflowTransitionEvent extends AbstractEvent
  24  {
  25      /**
  26       * Constructor.
  27       *
  28       * @param   string  $name       The event name.
  29       * @param   array   $arguments  The event arguments.
  30       *
  31       * @throws  BadMethodCallException
  32       *
  33       * @since   4.0.0
  34       */
  35      public function __construct($name, array $arguments = array())
  36      {
  37          $arguments['stopTransition'] = false;
  38  
  39          parent::__construct($name, $arguments);
  40      }
  41  
  42      /**
  43       * Set used parameter to true
  44       *
  45       * @param   bool  $value  The value to set
  46       *
  47       * @return void
  48       *
  49       * @since   4.0.0
  50       */
  51      public function setStopTransition($value = true)
  52      {
  53          $this->arguments['stopTransition'] = $value;
  54  
  55          if ($value === true) {
  56              $this->stopPropagation();
  57          }
  58      }
  59  }