- md5
- f43ef4d7f138c7f8076b509a0ba47eae
- sha1
- ed66b6ae45415c038240a1c55788a39b28e30a24
- sha256
- e3fd49f9666cc0613283600e7bd88816468d6d20632216f885e4efbb17448a87
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
<?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;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Event class for \Joomla\CMS\Table\Table onBeforePublish event
*
* @since 4.0.0
*/
class BeforePublishEvent extends AbstractEvent
{
/**
* Constructor.
*
* Mandatory arguments:
* subject \Joomla\CMS\Table\TableInterface The table we are operating on
* pks mixed An optional array of primary key values to update.
* state int The publishing state. eg. [0 = unpublished, 1 = published]
* userId int The user id of the user performing the operation.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @throws \BadMethodCallException
*/
public function __construct($name, array $arguments = [])
{
if (!\array_key_exists('pks', $arguments)) {
throw new \BadMethodCallException("Argument 'pks' is required for event $name");
}
if (!\array_key_exists('state', $arguments)) {
throw new \BadMethodCallException("Argument 'state' is required for event $name");
}
if (!\array_key_exists('userId', $arguments)) {
throw new \BadMethodCallException("Argument 'userId' is required for event $name");
}
parent::__construct($name, $arguments);
}
/**
* Setter for the pks argument
*
* @param array|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 setQuery($value)
{
if (!empty($value) && !\is_array($value)) {
throw new \BadMethodCallException("Argument 'pks' of event {$this->name} must be empty or an array");
}
return $value;
}
/**
* Setter for the state 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 setState($value)
{
if (!is_numeric($value)) {
throw new \BadMethodCallException("Argument 'state' of event {$this->name} must be an integer");
}
return (int) $value;
}
/**
* Setter for the userId 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 setUserId($value)
{
if (!is_numeric($value)) {
throw new \BadMethodCallException("Argument 'userId' of event {$this->name} must be an integer");
}
return (int) $value;
}
/**
* Setter for the pks argument
*
* @param array|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 onSetQuery($value)
{
return $this->setQuery($value);
}
/**
* Setter for the state 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 onSetState($value)
{
return $this->setState($value);
}
/**
* Setter for the userId 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 onSetUserId($value)
{
return $this->setUserId($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.