- md5
- 6a4d6ccd5c07fa83cda30c1b523f7263
- sha1
- 18b1443c169b12efc9ad968b76f71ff6a04be23d
- sha256
- 44d975b741f98e5c39bda5af05610117db88d03a3bab59325b572ed46fd76a40
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
<?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\Menu;
use Joomla\CMS\Event\AbstractImmutableEvent;
use Joomla\CMS\Event\ReshapeArgumentsAware;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Class for menu events
*
* @since 5.0.0
*/
class PreprocessMenuItemsEvent 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 = ['context', 'subject', 'params', 'enabled'];
/**
* 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 setContext(string $value): string
{
return $value;
}
/**
* Setter for the subject argument.
*
* @param array|\ArrayAccess $value The value to set
*
* @return array|\ArrayAccess
*
* @since 5.0.0
*/
protected function setSubject(array|\ArrayAccess $value): array|\ArrayAccess
{
return $value;
}
/**
* Setter for the registry argument.
*
* @param ?Registry $value The value to set
*
* @return ?Registry
*
* @since 5.0.0
*/
protected function setParams(?Registry $value): ?Registry
{
return $value;
}
/**
* Setter for the enabled argument.
*
* @param ?bool $value The value to set
*
* @return ?bool
*
* @since 5.0.0
*/
protected function setEnabled(?bool $value): ?bool
{
return $value;
}
/**
* Getter for the context.
*
* @return string
*
* @since 5.0.0
*/
public function getContext(): string
{
return $this->arguments['context'];
}
/**
* Getter for the items.
*
* @return array|\ArrayAccess
*
* @since 5.0.0
*/
public function getItems(): array|\ArrayAccess
{
return $this->arguments['subject'];
}
/**
* Getter for the params.
*
* @return ?Registry
*
* @since 5.0.0
*/
public function getParams(): ?Registry
{
return $this->arguments['params'] ?? null;
}
/**
* Getter for the enabled.
*
* @return ?bool
*
* @since 5.0.0
*/
public function getEnabled(): ?bool
{
return $this->arguments['enabled'] ?? null;
}
}
No other release has this exact content. See every version of this file.