- md5
- 282f4464b17eacdc1ef6e1a668b0f7bb
- sha1
- 69a322021f1d27e4dc872113d0c6254f823718df
- sha256
- c8c947844cb01e6172aa24939c5cc7318c830d89ddb4a0a9ae9f8731467009cb
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
<?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;
use Joomla\CMS\Authentication\AuthenticationResponse;
use Joomla\CMS\Event\Result\ResultAware;
use Joomla\CMS\Event\Result\ResultAwareInterface;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Class for User event.
* Example:
* new AuthorisationEvent('onEventName', ['subject' => $authenticationResponse, 'options' => $options]);
*
* @since 5.0.0
*/
class AuthorisationEvent extends UserEvent implements ResultAwareInterface
{
use ResultAware;
/**
* 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'];
/**
* Setter for the subject argument.
*
* @param AuthenticationResponse $value The value to set
*
* @return AuthenticationResponse
*
* @since 5.0.0
*/
protected function onSetSubject(AuthenticationResponse $value): AuthenticationResponse
{
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;
}
/**
* Checks the type of the data being appended to the result argument.
*
* @param mixed $data The data to type check
*
* @return void
* @throws \InvalidArgumentException
*
* @internal
* @since 5.0.0
*/
public function typeCheckResult($data): void
{
if (!$data instanceof AuthenticationResponse) {
throw new \InvalidArgumentException(\sprintf('Event %s only accepts AuthenticationResponse results.', $this->getName()));
}
}
/**
* Getter for the response.
*
* @return AuthenticationResponse
*
* @since 5.0.0
*/
public function getAuthenticationResponse(): AuthenticationResponse
{
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.