[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 onAfterLoad event
  20   *
  21   * @since  4.0.0
  22   */
  23  class AfterLoadEvent extends AbstractEvent
  24  {
  25      /**
  26       * Constructor.
  27       *
  28       * Mandatory arguments:
  29       * subject  JTableInterface The table we are operating on
  30       * result   boolean         Did the table record load succeed?
  31       * row      null|array      The values loaded from the database, null if it failed
  32       *
  33       * @param   string  $name       The event name.
  34       * @param   array   $arguments  The event arguments.
  35       *
  36       * @throws  BadMethodCallException
  37       */
  38      public function __construct($name, array $arguments = array())
  39      {
  40          if (!\array_key_exists('result', $arguments)) {
  41              throw new BadMethodCallException("Argument 'result' is required for event $name");
  42          }
  43  
  44          if (!\array_key_exists('row', $arguments)) {
  45              throw new BadMethodCallException("Argument 'row' is required for event $name");
  46          }
  47  
  48          parent::__construct($name, $arguments);
  49      }
  50  
  51      /**
  52       * Setter for the result argument
  53       *
  54       * @param   boolean  $value  The value to set
  55       *
  56       * @return  boolean
  57       *
  58       * @throws  BadMethodCallException  if the argument is not of the expected type
  59       */
  60      protected function setResult($value)
  61      {
  62          return $value ? true : false;
  63      }
  64  
  65      /**
  66       * Setter for the row argument
  67       *
  68       * @param   array|null  $value  The value to set
  69       *
  70       * @return  array|null
  71       *
  72       * @throws  BadMethodCallException  if the argument is not of the expected type
  73       */
  74      protected function setRow($value)
  75      {
  76          if (!\is_null($value) && !\is_array($value)) {
  77              throw new BadMethodCallException("Argument 'row' of event {$this->name} is not of the expected type");
  78          }
  79  
  80          return $value;
  81      }
  82  }