- md5
- 57159c5ed72efc70f0c1b8fd222be2fb
- sha1
- 3c7b6adc58f55ade3c8ab01ccd394ba94b1873db
- sha256
- eca3364393caf1f55a2b37205fc9537d196936fd5af759eb99c6fb8e4794072a
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
<?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.
* Example:
* new AfterRenderModulesEvent('onEventName', ['subject' => $content, 'attributes' => $attrs]);
*
* @since 5.0.0
*/
class AfterRenderModulesEvent extends ModuleEvent
{
/**
* The argument names, in order expected by legacy plugins.
*
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['content', 'attributes', 'subject'];
/**
* 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 = [])
{
// This event has a dummy subject for now
$this->arguments['subject'] ??= new \stdClass();
parent::__construct($name, $arguments);
if (!\array_key_exists('content', $this->arguments)) {
throw new \BadMethodCallException("Argument 'content' of event {$name} is required but has not been provided");
}
if (!\array_key_exists('attributes', $this->arguments)) {
throw new \BadMethodCallException("Argument 'attributes' of event {$name} is required but has not been provided");
}
// For backward compatibility make sure the content is referenced
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0) {
$this->arguments['content'] = &$arguments[0];
} elseif (\array_key_exists('content', $arguments)) {
$this->arguments['content'] = &$arguments['content'];
}
}
/**
* Setter for the content argument.
*
* @param string $value The value to set
*
* @return object
*
* @since 5.0.0
*/
protected function onSetContent(string $value): string
{
return $value;
}
/**
* Setter for the attributes argument.
*
* @param array $value The value to set
*
* @return array
*
* @since 5.0.0
*/
protected function onSetAttributes(array $value): array
{
return $value;
}
/**
* Getter for the content.
*
* @return object
*
* @since 5.0.0
*/
public function getContent(): string
{
return $this->arguments['content'];
}
/**
* Setter for the content.
*
* @param string $value The value to set
*
* @return static
*
* @since 5.0.0
*/
public function updateContent(string $value): static
{
$this->arguments['content'] = $this->onSetContent($value);
return $this;
}
/**
* Getter for the attributes argument.
*
* @return array
*
* @since 5.0.0
*/
public function getAttributes(): array
{
return $this->arguments['attributes'];
}
}
The same content is in 73 releases, Joomla 5.4.0-beta1 to 6.2.1-rc1. See them all, or every version of this file.