CoreFiles by mySites.guru
RenderModuleEvent.php103 lines, 2,299 bytes, from Joomla_5.0.0-beta1-Beta-Full_Package.zip
Raw History Compare with 4.4.0-beta3
md5
a9b396c68597b277dc4565130e7cc6ac
sha1
41cf7a85e111638c7d1c0042dc54b62f255a0e8c
sha256
d8bbd79b078a1eccbf18883e1fe406fde60b2f45793d27cd8b053b82964e425e
<?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.