- md5
- f6f920befd2c789ea95c6c90a3bfd742
- sha1
- 2689bc06b47c384020a7d2a613ade83609dbe350
- sha256
- 0204b0723f7115386871d0d5e2d18e9241f91a081498a864531581999d2ad6bd
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\CMS\Event\MultiFactor;
use DomainException;
use Joomla\CMS\Event\AbstractImmutableEvent;
use Joomla\CMS\Event\Result\ResultAware;
use Joomla\CMS\Event\Result\ResultAwareInterface;
use Joomla\CMS\Event\Result\ResultTypeBooleanAware;
use Joomla\CMS\User\User;
use Joomla\Component\Users\Administrator\Table\MfaTable;
// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Concrete Event class for the onUserMultifactorValidate event
*
* @since 4.2.0
*/
class Validate extends AbstractImmutableEvent implements ResultAwareInterface
{
use ResultAware;
use ResultTypeBooleanAware;
/**
* Public constructor
*
* @param MfaTable $record The MFA record to validate against
* @param User $user The user currently logged into the site
* @param string $code The MFA code we are validating
*
* @since 4.2.0
*/
public function __construct(MfaTable $record, User $user, string $code)
{
parent::__construct(
'onUserMultifactorValidate',
[
'record' => $record,
'user' => $user,
'code' => $code,
]
);
}
/**
* Validate the value of the 'record' named parameter
*
* @param MfaTable $value The value to validate
*
* @return MfaTable
* @since 4.2.0
*/
public function setRecord(MfaTable $value): MfaTable
{
if (empty($value)) {
throw new DomainException(sprintf('Argument \'record\' of event %s must be a MfaTable object.', $this->name));
}
return $value;
}
/**
* Validate the value of the 'user' named parameter
*
* @param User $value The value to validate
*
* @return User
* @since 4.2.0
*/
public function setUser(User $value): User
{
if (empty($value) || ($value->id <= 0) || ($value->guest == 1)) {
throw new DomainException(sprintf('Argument \'user\' of event %s must be a non-guest User object.', $this->name));
}
return $value;
}
/**
* Validate the value of the 'code' named parameter
*
* @param string|null $value The value to validate
*
* @return string|null
* @since 4.2.0
*/
public function setCode(?string $value): ?string
{
// No validation necessary, the type check in the method options is enough
return $value;
}
}
The same content is in 27 releases, Joomla 4.2.1 to 4.3.1. See them all, or every version of this file.