- md5
- c4f9b20b686a803f8d8ed0db15ac7298
- sha1
- b1248f55a2123bfce2facd3c06966003711f20bf
- sha256
- 8cd61510bdd217d4edcd7aaf082fa3b1ff72ba06ba96a8ac53302d032de557b3
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
<?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 Joomla\Database\DatabaseQuery;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Event class for JTable's onBeforeMove event
*
* @since 4.0.0
*/
class BeforeMoveEvent extends AbstractEvent
{
/**
* Constructor.
*
* Mandatory arguments:
* subject JTableInterface The table we are operating on
* query DatabaseQuery The query to get the primary keys and ordering values for the selection.
* delta int The direction and magnitude to move the row in the ordering sequence.
* where string WHERE clause to use 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('query', $arguments)) {
throw new \BadMethodCallException("Argument 'query' 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 'where' is required for event $name");
}
parent::__construct($name, $arguments);
}
/**
* Setter for the query argument
*
* @param DatabaseQuery $value The value to set
*
* @return mixed
*
* @throws \BadMethodCallException if the argument is not of the expected type
*
* @deprecated 4.4.0 will be removed in 6.0
* Use counterpart with onSet prefix
*/
protected function setQuery($value)
{
if (!($value instanceof DatabaseQuery)) {
throw new \BadMethodCallException("Argument 'query' of event {$this->name} must be of DatabaseQuery type");
}
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
*
* @deprecated 4.4.0 will be removed in 6.0
* Use counterpart with onSet prefix
*/
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
*
* @deprecated 4.4.0 will be removed in 6.0
* Use counterpart with onSet prefix
*/
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;
}
/**
* Setter for the query argument
*
* @param DatabaseQuery $value The value to set
*
* @return mixed
*
* @throws \BadMethodCallException if the argument is not of the expected type
*
* @since 4.4.0
*/
protected function onSetQuery($value)
{
return $this->setQuery($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
*
* @since 4.4.0
*/
protected function onSetDelta($value)
{
return $this->setDelta($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
*
* @since 4.4.0
*/
protected function onSetWhere($value)
{
return $this->setWhere($value);
}
}
The same content is in 31 releases, Joomla 4.4.0-beta3 to 4.4.14. See them all, or every version of this file.