- md5
- 975edd1ee1b0e4d7b6a030764d9f25de
- sha1
- 1b1a6e2ef4cf86412365e686dadc8387e516c817
- sha256
- f6bb406c6c8e64728fef2ba28512cc4403f0265f43320adbe2b676ba13d5cfa9
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Event\Model;
use Joomla\CMS\Event\AbstractImmutableEvent;
use Joomla\CMS\Event\ReshapeArgumentsAware;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Base class for Model events
*
* @since 5.0.0
*/
abstract class ModelEvent extends AbstractImmutableEvent
{
use ReshapeArgumentsAware;
/**
* The argument names, in order expected by legacy plugins.
*
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 6.0
*/
protected $legacyArgumentsOrder = [];
/**
* Constructor.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @throws \BadMethodCallException
*
* @since 5.0.0
*/
public function __construct($name, array $arguments = [])
{
// Reshape the arguments array to preserve b/c with legacy listeners
if ($this->legacyArgumentsOrder) {
$arguments = $this->reshapeArguments($arguments, $this->legacyArgumentsOrder);
}
parent::__construct($name, $arguments);
if (!\array_key_exists('context', $this->arguments)) {
throw new \BadMethodCallException("Argument 'context' of event {$name} is required but has not been provided");
}
if (!\array_key_exists('subject', $this->arguments)) {
throw new \BadMethodCallException("Argument 'subject' of event {$name} is required but has not been provided");
}
}
/**
* Setter for the context argument.
*
* @param string $value The value to set
*
* @return string
*
* @since 5.0.0
*/
protected function onSetContext(string $value): string
{
return $value;
}
/**
* Getter for the context argument.
*
* @return string
*
* @since 5.0.0
*/
public function getContext(): string
{
return $this->arguments['context'];
}
}
The same content is in 76 releases, Joomla 5.0.0-beta3 to 6.0.0-alpha3. See them all, or every version of this file.