[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 onAfterReorder event
  20   *
  21   * @since  4.0.0
  22   */
  23  class AfterReorderEvent extends AbstractEvent
  24  {
  25      /**
  26       * Constructor.
  27       *
  28       * Mandatory arguments:
  29       * subject      JTableInterface The table we are operating on
  30       * rows         stdClass[]|null The primary keys and ordering values for the selection.
  31       * where        string          WHERE clause which was used for limiting the selection of rows to compact the ordering values.
  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('where', $arguments)) {
  41              throw new BadMethodCallException("Argument 'ignore' is required for event $name");
  42          }
  43  
  44          parent::__construct($name, $arguments);
  45      }
  46  
  47      /**
  48       * Setter for the where argument
  49       *
  50       * @param   array|string|null  $value  A string or array of where conditions.
  51       *
  52       * @return  mixed
  53       *
  54       * @throws  BadMethodCallException  if the argument is not of the expected type
  55       */
  56      protected function setWhere($value)
  57      {
  58          if (!empty($value) && !\is_string($value) && !\is_array($value)) {
  59              throw new BadMethodCallException("Argument 'where' of event {$this->name} must be empty or string or array of strings");
  60          }
  61  
  62          return $value;
  63      }
  64  }