[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2016 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\Table;
  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 JTable's onAfterStore event
  20   *
  21   * @since  4.0.0
  22   */
  23  class AfterStoreEvent extends AbstractEvent
  24  {
  25      /**
  26       * Constructor.
  27       *
  28       * Mandatory arguments:
  29       * subject      JTableInterface The table we are operating on
  30       * result       boolean         Did the save succeed?
  31       *
  32       * @param   string  $name       The event name.
  33       * @param   array   $arguments  The event arguments.
  34       *
  35       * @throws  BadMethodCallException
  36       */
  37      public function __construct($name, array $arguments = array())
  38      {
  39          if (!\array_key_exists('result', $arguments)) {
  40              throw new BadMethodCallException("Argument 'result' is required for event $name");
  41          }
  42  
  43          parent::__construct($name, $arguments);
  44      }
  45  
  46      /**
  47       * Setter for the result argument
  48       *
  49       * @param   boolean  $value  The value to set
  50       *
  51       * @return  boolean
  52       *
  53       * @throws  BadMethodCallException  if the argument is not of the expected type
  54       */
  55      protected function setResult($value)
  56      {
  57          return $value ? true : false;
  58      }
  59  }