- md5
- 083bc15893b0c203d20f11d65c447c04
- sha1
- ad8cc8e8fef0b1bf3bb2690d5b5425d0ed37b2c5
- sha256
- 9d7b40083d7ab77b14158125e00640fc4ec276fe7517e5ebb0f807d672da525f
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
<?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\User;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Base class for User login event
*
* @since 5.0.0
*/
abstract class AbstractLoginEvent extends UserEvent
{
/**
* 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', 'options'];
/**
* Constructor.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @throws \BadMethodCallException
*
* @since 5.2.0
*/
public function __construct($name, array $arguments = [])
{
if (\count($arguments) === 1) {
// @TODO: Remove in Joomla 7, and set 'options' argument as required.
$missingKey = empty($arguments['subject']) ? 'subject' : 'options';
$arguments[key($arguments) === 0 ? 1 : $missingKey] = [];
@trigger_error(
\sprintf('The event %s requires 2 arguments. Use of 1 argument will throw an exception in Joomla 7.', $this->getName()),
E_USER_DEPRECATED
);
}
parent::__construct($name, $arguments);
}
/**
* Setter for the subject argument.
*
* @param array $value The value to set
*
* @return array
*
* @since 5.0.0
*/
protected function onSetSubject(array $value): array
{
return $value;
}
/**
* Setter for the options argument.
*
* @param array $value The value to set
*
* @return array
*
* @since 5.0.0
*/
protected function onSetOptions(array $value): array
{
return $value;
}
/**
* Getter for the response.
*
* @return array
*
* @since 5.0.0
*/
public function getAuthenticationResponse(): array
{
return $this->arguments['subject'];
}
/**
* Getter for the options.
*
* @return array
*
* @since 5.0.0
*/
public function getOptions(): array
{
return $this->arguments['options'] ?? [];
}
}
The same content is in 39 releases, Joomla 5.2.0-beta3 to 6.0.0-alpha3. See them all, or every version of this file.