CoreFiles by mySites.guru
AfterMoveEvent.php110 lines, 3,205 bytes, from Joomla_4.3.4-Stable-Full_Package.zip
Raw History Compare with 4.3.3
md5
06beb6b8803500c1ddb59062c5241092
sha1
175ad7cb5de6ceee0ba7fce1bab7ebd475b7eae4
sha256
0470b5b71ac0143c0d893ed3412f729c06bea0531339cfc64863aea671667df2
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2016 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Event\Table;

use BadMethodCallException;
use stdClass;

// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Event class for JTable's onAfterMove event
 *
 * @since  4.0.0
 */
class AfterMoveEvent extends AbstractEvent
{
    /**
     * Constructor.
     *
     * Mandatory arguments:
     * subject      JTableInterface The table we are operating on
     * row          stdClass|null   The primary keys and ordering value for the selection.
     * delta        int             The direction and magnitude to move the row in the ordering sequence.
     * where        string          WHERE clause which was used for limiting the selection of rows to compact the ordering values.
     *
     * @param   string  $name       The event name.
     * @param   array   $arguments  The event arguments.
     *
     * @throws  BadMethodCallException
     */
    public function __construct($name, array $arguments = [])
    {
        if (!\array_key_exists('row', $arguments)) {
            throw new BadMethodCallException("Argument 'row' is required for event $name");
        }

        if (!\array_key_exists('delta', $arguments)) {
            throw new BadMethodCallException("Argument 'delta' is required for event $name");
        }

        if (!\array_key_exists('where', $arguments)) {
            throw new BadMethodCallException("Argument 'ignore' is required for event $name");
        }

        parent::__construct($name, $arguments);
    }

    /**
     * Setter for the rows argument
     *
     * @param   stdClass|null  $value  The value to set
     *
     * @return  mixed
     *
     * @throws  BadMethodCallException  if the argument is not of the expected type
     */
    protected function setRow($value)
    {
        if (!($value instanceof stdClass) && !empty($value)) {
            throw new BadMethodCallException("Argument 'row' of event {$this->name} must be an stdClass object or null");
        }

        return $value;
    }

    /**
     * Setter for the delta argument
     *
     * @param   int  $value  The value to set
     *
     * @return  integer
     *
     * @throws  BadMethodCallException  if the argument is not of the expected type
     */
    protected function setDelta($value)
    {
        if (!is_numeric($value)) {
            throw new BadMethodCallException("Argument 'delta' of event {$this->name} must be an integer");
        }

        return (int) $value;
    }

    /**
     * Setter for the where argument
     *
     * @param   string|null  $value  The value to set
     *
     * @return  mixed
     *
     * @throws  BadMethodCallException  if the argument is not of the expected type
     */
    protected function setWhere($value)
    {
        if (!empty($value) && !\is_string($value)) {
            throw new BadMethodCallException("Argument 'where' of event {$this->name} must be empty or string");
        }

        return $value;
    }
}

The same content is in 8 releases, Joomla 4.3.2-rc1 to 4.4.0-alpha2. See them all, or every version of this file.