AdapterInterface.php
3.33 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?php
namespace Phalcon\Acl {
/**
* Phalcon\Acl\AdapterInterface initializer
*/
interface AdapterInterface {
/**
* Sets the default access level (Phalcon\Acl::ALLOW or \Phalcon\Acl::DENY)
*
* @param int $defaultAccess
*/
public function setDefaultAction($defaultAccess);
/**
* Returns the default ACL access level
*
* @return int
*/
public function getDefaultAction();
/**
* Adds a role to the ACL list. Second parameter lets to inherit access data from other existing role
*
* @param \Phalcon\Acl\RoleInterface $role
* @param string $accessInherits
* @return boolean
*/
public function addRole($role, $accessInherits=null);
/**
* Do a role inherit from another existing role
*
* @param string $roleName
* @param string $roleToInherit
*/
public function addInherit($roleName, $roleToInherit);
/**
* Check whether role exist in the roles list
*
* @param string $roleName
* @return boolean
*/
public function isRole($roleName);
/**
* Check whether resource exist in the resources list
*
* @param string $resourceName
* @return boolean
*/
public function isResource($resourceName);
/**
* Adds a resource to the ACL list
*
* Access names can be a particular action, by example
* search, update, delete, etc or a list of them
*
* @param \Phalcon\Acl\ResourceInterface $resource
* @param array $accessList
* @return boolean
*/
public function addResource($resource, $accessList=null);
/**
* Adds access to resources
*
* @param string $resourceName
* @param mixed $accessList
*/
public function addResourceAccess($resourceName, $accessList);
/**
* Removes an access from a resource
*
* @param string $resourceName
* @param mixed $accessList
*/
public function dropResourceAccess($resourceName, $accessList);
/**
* Allow access to a role on a resource
*
* @param string $roleName
* @param string $resourceName
* @param mixed $access
*/
public function allow($roleName, $resourceName, $access);
/**
* Deny access to a role on a resource
*
* @param string $roleName
* @param string $resourceName
* @param mixed $access
* @return boolean
*/
public function deny($roleName, $resourceName, $access);
/**
* Check whether a role is allowed to access an action from a resource
*
* @param string $role
* @param string $resource
* @param string $access
* @return boolean
*/
public function isAllowed($role, $resource, $access);
/**
* Returns the role which the list is checking if it's allowed to certain resource/access
*
* @return string
*/
public function getActiveRole();
/**
* Returns the resource which the list is checking if some role can access it
*
* @return string
*/
public function getActiveResource();
/**
* Returns the access which the list is checking if some role can access it
*
* @return string
*/
public function getActiveAccess();
/**
* Return an array with every role registered in the list
*
* @return \Phalcon\Acl\RoleInterface[]
*/
public function getRoles();
/**
* Return an array with every resource registered in the list
*
* @return \Phalcon\Acl\ResourceInterface[]
*/
public function getResources();
}
}