-
Notifications
You must be signed in to change notification settings - Fork 145
Expand file tree
/
Copy pathResult.php
More file actions
69 lines (57 loc) · 1.53 KB
/
Result.php
File metadata and controls
69 lines (57 loc) · 1.53 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?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;
}
}