- md5
- 6146062a0d24762648b27b978b9c4d66
- sha1
- 13e70a9998af5e5dd5823ed9e49054baa1c2982d
- sha256
- 16d8cbe3b15be9b95f061d3c498f467be1de480d443fa7cbf8ee5815014d8a8d
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
<?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;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* This class implements the immutable base Event object used system-wide to offer orthogonality.
*
* @see \Joomla\CMS\Event\AbstractEvent
* @since 4.0.0
*/
class AbstractImmutableEvent extends AbstractEvent
{
/**
* A flag to see if the constructor has been already called.
*
* @var boolean
* @since 4.0.0
*/
private $constructed = false;
/**
* Constructor.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @since 4.0.0
* @throws \BadMethodCallException
*/
public function __construct(string $name, array $arguments = [])
{
if ($this->constructed) {
throw new \BadMethodCallException(
\sprintf('Cannot reconstruct the AbstractImmutableEvent %s.', $this->name)
);
}
$this->constructed = true;
parent::__construct($name, $arguments);
}
/**
* Set the value of an event argument.
*
* @param string $name The argument name.
* @param mixed $value The argument value.
*
* @return void
*
* @since 4.0.0
* @throws \BadMethodCallException
*/
public function offsetSet($name, $value)
{
// B/C check for plugins which use $event['result'] = $result;
if ($name === 'result') {
parent::offsetSet($name, $value);
@trigger_error(
'Setting a result in an immutable event is deprecated, and will not work in Joomla 6. Event ' . $this->getName(),
E_USER_DEPRECATED
);
return;
}
throw new \BadMethodCallException(
\sprintf(
'Cannot set the argument %s of the immutable event %s.',
$name,
$this->name
)
);
}
/**
* Remove an event argument.
*
* @param string $name The argument name.
*
* @return void
*
* @since 4.0.0
* @throws \BadMethodCallException
*/
public function offsetUnset($name)
{
throw new \BadMethodCallException(
\sprintf(
'Cannot remove the argument %s of the immutable event %s.',
$name,
$this->name
)
);
}
}
The same content is in 39 releases, Joomla 5.2.0-beta3 to 6.0.0-alpha3. See them all, or every version of this file.