- md5
- 72cb28d949b5a7cf5f0deffedc52bb04
- sha1
- 2275084458f96fcbdb50e4610840d91c58843b23
- sha256
- 7884a60bfad53fcc9037d79a5f25543d3d358d00e32cb8825c6d025170e0e335
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
<?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('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Event class for \Joomla\CMS\Table\Table onBeforeReorder event
*
* @since 4.0.0
*/
class BeforeReorderEvent extends AbstractEvent
{
/**
* Constructor.
*
* Mandatory arguments:
* subject \Joomla\CMS\Table\TableInterface The table we are operating on
* query DatabaseQuery The query to get the primary keys and ordering values for the selection.
* 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('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 where argument
*
* @param array|string|null $value A string or array of where conditions.
*
* @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) && !\is_array($value)) {
throw new \BadMethodCallException("Argument 'where' of event {$this->name} must be empty or string or array of strings");
}
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 where argument
*
* @param array|string|null $value A string or array of where conditions.
*
* @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 75 releases, Joomla 5.0.0-rc to 6.0.0-alpha3. See them all, or every version of this file.