blob: 66959afb65c5a756abe606157bceaecbca02a451 (
plain) (
blame)
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
89
90
91
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*
* @file
*/
namespace MediaWiki\Actions;
/**
* Provides information about an action that can be used to determine whether the action
* can be executed in a given context.
*
* @since 1.41
* @author Daniel Kinzler
*/
class ActionInfo {
private string $name;
private ?string $restriction;
private bool $needsReadRights;
private bool $requiresWrite;
private bool $requiresUnblock;
/**
* Constructs ActionInfo based on an action object spec which is expected to
* include the following keys:
* - name: the canonical name of the action (string)
* - requiresUnblock: Whether this action can still be executed by a blocked user (bool)
* - requiresWrite: Whether this action requires the wiki not to be locked (bool)
* - needsReadRights: whether this action requires read rights (bool)
* - restriction: the permission required to perform this action (string, or null for none)
*
* @param array $spec The action spec
*/
public function __construct( array $spec ) {
$this->name = $spec['name'];
$this->restriction = $spec['restriction'];
$this->needsReadRights = $spec['needsReadRights'];
$this->requiresWrite = $spec['requiresWrite'];
$this->requiresUnblock = $spec['requiresUnblock'];
}
/**
* @return string The action's name
*/
public function getName(): string {
return $this->name;
}
/**
* @return ?string A permission required to execute the action
*/
public function getRestriction(): ?string {
return $this->restriction;
}
/**
* @return bool Whether the action requires the user to have read access
*/
public function needsReadRights(): bool {
return $this->needsReadRights;
}
/**
* @return bool Whether the action requires the database to be writable
*/
public function requiresWrite(): bool {
return $this->requiresWrite;
}
/**
* @return bool Whether the action requires the user to not be blocked
*/
public function requiresUnblock(): bool {
return $this->requiresUnblock;
}
}
|
