CoreFiles by mySites.guru
Validate.php101 lines, 2,406 bytes, from Joomla_4.2.0-beta2-Beta-Full_Package.zip
Raw History Compare with 4.2.0-beta1
md5
61209d509c7a683df87eea620c7e4617
sha1
d753fca28ded4633cb0ea375ebb0f54ab3d10840
sha256
d82be30e717aafafa4d16a82dba3d0bc180502ae0faef53fda4f0b385c083ae2
<?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;

\defined('JPATH_PLATFORM') or die;

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;

/**
 * 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 2 releases, Joomla 4.2.0-beta1 to 4.2.0-beta2. See them all, or every version of this file.