- md5
- a9b396c68597b277dc4565130e7cc6ac
- sha1
- 41cf7a85e111638c7d1c0042dc54b62f255a0e8c
- sha256
- d8bbd79b078a1eccbf18883e1fe406fde60b2f45793d27cd8b053b82964e425e
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
<?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\Module;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Class for Module events
*
* @since 5.0.0
*/
abstract class RenderModuleEvent extends ModuleEvent
{
/**
* 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 = ['subject', 'attributes'];
/**
* 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 = [])
{
parent::__construct($name, $arguments);
if (!\array_key_exists('attributes', $this->arguments)) {
throw new \BadMethodCallException("Argument 'attributes' of event {$name} is required but has not been provided");
}
}
/**
* Setter for the subject argument.
*
* @param object $value The value to set
*
* @return object
*
* @since 5.0.0
*/
protected function setSubject(object $value): object
{
return $value;
}
/**
* Setter for the attributes argument.
*
* @param array|\ArrayAccess $value The value to set
*
* @return array|\ArrayAccess
*
* @since 5.0.0
*/
protected function setAttributes(array|\ArrayAccess $value): array|\ArrayAccess
{
return $value;
}
/**
* Getter for the subject argument.
*
* @return object
*
* @since 5.0.0
*/
public function getModule(): object
{
return $this->arguments['subject'];
}
/**
* Getter for the attributes argument.
*
* @return array|\ArrayAccess
*
* @since 5.0.0
*/
public function getAttributes(): array|\ArrayAccess
{
return $this->arguments['attributes'];
}
}
The same content is in 2 releases, Joomla 5.0.0-alpha4 to 5.0.0-beta1. See them all, or every version of this file.