- md5
- a80dffbe5205d52fc336d4ed7180b638
- sha1
- ee3ac08598bb3dd2f33892f2300ae5f488bc527c
- sha256
- 06365a84c0eb5f9307d4a6fcf54b562413535759f9bcf6736a5e0911d534e0f9
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
<?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\CMS\MVC\Model\BaseModel;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Class for menu events
*
* @since 5.0.0
*/
class AfterGetMenuTypeOptionsEvent 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 7.0
*/
protected $legacyArgumentsOrder = ['items', '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 = [])
{
// Reshape the arguments array to preserve b/c with legacy listeners
if ($this->legacyArgumentsOrder) {
parent::__construct($name, $this->reshapeArguments($arguments, $this->legacyArgumentsOrder));
} else {
parent::__construct($name, $arguments);
}
if (!\array_key_exists('items', $this->arguments)) {
throw new \BadMethodCallException("Argument 'items' 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");
}
// 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['items'] = &$arguments[0];
} elseif (\array_key_exists('items', $arguments)) {
$this->arguments['items'] = &$arguments['items'];
}
}
/**
* Setter for the subject argument.
*
* @param BaseModel $value The value to set
*
* @return BaseModel
*
* @since 5.0.0
*/
protected function onSetSubject(BaseModel $value): BaseModel
{
return $value;
}
/**
* Setter for the items argument.
*
* @param array $value The value to set
*
* @return array
*
* @since 5.0.0
*/
protected function onSetItems(array $value): array
{
return $value;
}
/**
* Getter for the model.
*
* @return BaseModel
*
* @since 5.0.0
*/
public function getModel(): BaseModel
{
return $this->arguments['subject'];
}
/**
* Getter for the items.
*
* @return array
*
* @since 5.0.0
*/
public function getItems(): array
{
return $this->arguments['items'];
}
/**
* Update the items.
*
* @param array $value The value to set
*
* @return static
*
* @since 5.0.0
*/
public function updateItems(array $value): static
{
$this->arguments['items'] = $this->onSetItems($value);
return $this;
}
}
The same content is in 72 releases, Joomla 5.4.0-beta1 to 6.2.0. See them all, or every version of this file.