You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
1.5 KiB
PHP
70 lines
1.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* This file is part of CodeIgniter Shield.
|
|
*
|
|
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
|
*
|
|
* For the full copyright and license information, please view
|
|
* the LICENSE file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace CodeIgniter\Shield;
|
|
|
|
use CodeIgniter\Shield\Entities\User;
|
|
|
|
class Result
|
|
{
|
|
protected bool $success = false;
|
|
|
|
/**
|
|
* Provides a simple explanation of
|
|
* the error that happened.
|
|
* Typically, a single sentence.
|
|
*/
|
|
protected ?string $reason = null;
|
|
|
|
/**
|
|
* Extra information.
|
|
*
|
|
* @var string|User|null `User` when successful. Suggestion strings when fails.
|
|
*/
|
|
protected $extraInfo;
|
|
|
|
/**
|
|
* @phpstan-param array{success: bool, reason?: string|null, extraInfo?: string|User} $details
|
|
* @psalm-param array{success: bool, reason?: string|null, extraInfo?: string|User} $details
|
|
*/
|
|
public function __construct(array $details)
|
|
{
|
|
foreach ($details as $key => $value) {
|
|
assert(property_exists($this, $key), 'Property "' . $key . '" does not exist.');
|
|
|
|
$this->{$key} = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Was the result a success?
|
|
*/
|
|
public function isOK(): bool
|
|
{
|
|
return $this->success;
|
|
}
|
|
|
|
public function reason(): ?string
|
|
{
|
|
return $this->reason;
|
|
}
|
|
|
|
/**
|
|
* @return string|User|null `User` when successful. Suggestion strings when fails.
|
|
*/
|
|
public function extraInfo()
|
|
{
|
|
return $this->extraInfo;
|
|
}
|
|
}
|