-
-
Notifications
You must be signed in to change notification settings - Fork 826
/
AbstractPolicy.php
88 lines (75 loc) · 2.15 KB
/
AbstractPolicy.php
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
namespace Flarum\User\Access;
use Flarum\User\User;
abstract class AbstractPolicy
{
public const GLOBAL = 'GLOBAL';
public const ALLOW = 'ALLOW';
public const DENY = 'DENY';
public const FORCE_ALLOW = 'FORCE_ALLOW';
public const FORCE_DENY = 'FORCE_DENY';
protected function allow()
{
return static::ALLOW;
}
protected function deny()
{
return static::DENY;
}
protected function forceAllow()
{
return static::FORCE_ALLOW;
}
protected function forceDeny()
{
return static::FORCE_DENY;
}
/**
* @param User $user
* @param string $ability
* @param $instance
* @return string|void
*/
public function checkAbility(User $actor, string $ability, $instance)
{ // If a specific method for this ability is defined,
// call that and return any non-null results
if (method_exists($this, $ability)) {
$result = $this->sanitizeResult(call_user_func_array([$this, $ability], [$actor, $instance]));
if (! is_null($result)) {
return $result;
}
}
// If a "total access" method is defined, try that.
if (method_exists($this, 'can')) {
return $this->sanitizeResult(call_user_func_array([$this, 'can'], [$actor, $ability, $instance]));
}
}
/**
* Allows `true` to be used in place of `->allow()`, and `false` instead of `->deny()`
* This allows more concise and intuitive code, by returning boolean statements:.
*
* WITHOUT THIS:
* `return SOME_BOOLEAN_LOGIC ? $this->allow() : $this->deny();
*
* WITH THIS:
* `return SOME_BOOLEAN_LOGIC;
*
* @param mixed $result
* @return string|void
*/
public function sanitizeResult($result)
{
if ($result === true) {
return $this->allow();
} elseif ($result === false) {
return $this->deny();
}
return $result;
}
}