CoreFiles by mySites.guru
BeforeRenderMenuItemsViewEvent.php88 lines, 2,106 bytes, from Joomla_6.2.0-Stable-Full_Package.zip
Raw History Compare with 6.1.4
md5
d9dad6b04b2ea4901a0cb3ff7e93e068
sha1
7e9ea68546e1553b9b4e8325bb28e22291c9e8f1
sha256
ce0182c64940a781e760bbf18967dee2940bea01bab6de6f33fb120db42e79f5
<?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\View\HtmlView;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Class for menu events
 *
 * @since  5.0.0
 */
class BeforeRenderMenuItemsViewEvent 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 = ['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) {
            $arguments = $this->reshapeArguments($arguments, $this->legacyArgumentsOrder);
        }

        parent::__construct($name, $arguments);

        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 subject argument.
     *
     * @param   HtmlView  $value  The value to set
     *
     * @return  HtmlView
     *
     * @since  5.0.0
     */
    protected function onSetSubject(HtmlView $value): HtmlView
    {
        return $value;
    }

    /**
     * Getter for the view.
     *
     * @return  HtmlView
     *
     * @since  5.0.0
     */
    public function getView(): HtmlView
    {
        return $this->arguments['subject'];
    }
}

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.