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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 <?php
/* --------------------------------------------------------------
AdminAccessServiceInterface.inc.php 2018-01-15
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface AuthServiceInterface
*
* @category System
* @package AdminAccess
* @subpackage Interfaces
*/
interface AdminAccessServiceInterface
{
/**
* Checks the deleting permission for a controller.
*
* @param NonEmptyStringType $identifier The name of a controller to identify an admin access group.
* @param IdType $customerId ID of a customer to check the permission for.
*
* @return bool True if customer has a deleting permission for the controller, false otherwise.
*/
public function checkDeletingPermissionForController(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the deleting permission for a page.
*
* @param NonEmptyStringType $identifier The name of a page to identify an admin access group.
* @param IdType $customerId ID of a customer to check permission for.
*
* @return bool True if customer has a deleting permission for the page, false otherwise.
*/
public function checkDeletingPermissionForPage(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the deleting permission for an ajax handler.
*
* @param NonEmptyStringType $identifier The name of an ajax handler to identify an admin access group.
* @param IdType $customerId ID of a customer to check permission for.
*
* @return bool True if customer has a deleting permission for the ajax handler, false otherwise.
*/
public function checkDeletingPermissionForAjaxHandler(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the reading permission for a controller.
*
* @param NonEmptyStringType $identifier The name of a controller to identify an admin access group.
* @param IdType $customerId ID of a customer to check the permission for.
*
* @return bool True if customer has a reading permission for the controller, false otherwise.
*/
public function checkReadingPermissionForController(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the reading permission for a page.
*
* @param NonEmptyStringType $identifier The name of a page to identify an admin access group.
* @param IdType $customerId ID of a customer to check permission for.
*
* @return bool True if customer has a reading permission for the page, false otherwise.
*/
public function checkReadingPermissionForPage(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the reading permission for an ajax handler.
*
* @param NonEmptyStringType $identifier The name of an ajax handler to identify an admin access group.
* @param IdType $customerId ID of a customer to check permission for.
*
* @return bool True if customer has a reading permission for the ajax handler, false otherwise.
*/
public function checkReadingPermissionForAjaxHandler(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the writing permission for a controller.
*
* @param NonEmptyStringType $identifier The name of a controller to identify an admin access group.
* @param IdType $customerId ID of a customer to check the permission for.
*
* @return bool True if customer has a writing permission for the controller, false otherwise.
*/
public function checkWritingPermissionForController(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the writing permission for a page.
*
* @param NonEmptyStringType $identifier The name of a page to identify an admin access group.
* @param IdType $customerId ID of a customer to check permission for.
*
* @return bool True if customer has a writing permission for the page, false otherwise.
*/
public function checkWritingPermissionForPage(NonEmptyStringType $identifier, IdType $customerId);
/**
* Checks the writing permission for an ajax handler.
*
* @param NonEmptyStringType $identifier The name of an ajax handler to identify an admin access group.
* @param IdType $customerId ID of a customer to check permission for.
*
* @return bool True if customer has a writing permission for the ajax handler, false otherwise.
*/
public function checkWritingPermissionForAjaxHandler(NonEmptyStringType $identifier, IdType $customerId);
/**
* Returns a collection of all permissions by a given role ID.
*
* @param IdType $roleId Role ID.
*
* @return AdminAccessPermissionCollection Permission collection object with all role permissions.
*/
public function getPermissionsByRoleId(IdType $roleId);
/**
* Adds a role to a user by a given role and customer ID.
*
* @param IdType $roleId Role ID.
* @param IdType $customerId Customer ID.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function addRoleToUserByCustomerId(IdType $roleId, IdType $customerId);
/**
* Removes a role from a user by given role and customer ID.
*
* @param IdType $roleId Role ID.
* @param IdType $customerId Customer ID.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function removeRoleFromUserByCustomerId(IdType $roleId, IdType $customerId);
/**
* Returns all roles of certain user by a given user ID.
*
* @param idType $id User ID.
*
* @return AdminAccessRoleCollection Collection of all roles that certain user has.
*/
public function getRolesByCustomerId(IdType $id);
/**
* Grants deleting permission to a role for a given group id.
*
* @param IdType $groupId Group ID to grant permission for.
* @param IdType $roleId Role ID to grant permission for.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function grantDeletingPermissionToRole(IdType $groupId, IdType $roleId);
/**
* Removes deleting permission from role for a given group id.
*
* @param IdType $groupId Group ID to remove permission for.
* @param IdType $roleId Role ID to remove permission from.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function removeDeletingPermissionFromRole(IdType $groupId, IdType $roleId);
/**
* Grants reading permission to a role for a given group id.
*
* @param IdType $groupId Group ID to grant permission for.
* @param IdType $roleId Role ID to grant permission for.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function grantReadingPermissionToRole(IdType $groupId, IdType $roleId);
/**
* Removes reading permission from role for a given group id.
*
* @param IdType $groupId Group ID to remove permission for.
* @param IdType $roleId Role ID to remove permission from.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function removeReadingPermissionFromRole(IdType $groupId, IdType $roleId);
/**
* Grants writing permission to a role for a given group id.
*
* @param IdType $groupId Group ID to grant permission for.
* @param IdType $roleId Role ID to grant permission for.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function grantWritingPermissionToRole(IdType $groupId, IdType $roleId);
/**
* Removes writing permission from role for a given group id.
*
* @param IdType $groupId Group ID to remove permission for.
* @param IdType $roleId Role ID to remove permission from.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function removeWritingPermissionFromRole(IdType $groupId, IdType $roleId);
/**
* Creates a new role.
*
* @param KeyValueCollection $name Collection with the role names. Index of a role name must be
* his language code.
* @param KeyValueCollection $description Collection with the role descriptions. Index of a role name
* must be his language code.
* @param IntType $sortOrder Roles sort order.
* @param BoolType $unknownReadingGranted Value of the reading permission for unknown groups.
* @param BoolType $unknownWritingGranted Value of the writing permission for unknown groups.
* @param BoolType $unknownDeletingGranted Value of the deleting permission for unknown groups.
*
* @return \AdminAccessRoleInterface Returns the create role.
*/
public function createNewRole(KeyValueCollection $name,
KeyValueCollection $description,
IntType $sortOrder,
BoolType $unknownReadingGranted,
BoolType $unknownWritingGranted,
BoolType $unknownDeletingGranted);
/**
* Updates a role by a given role ID.
*
* @param IdType $roleId Role ID to remove permission from.
* @param KeyValueCollection $newName Collection with the new role names. Index of a role name must
* be his language code.
* @param KeyValueCollection $newDescription Collection with the new role descriptions. Index of a role
* name must be his language code.
* @param IntType $newSortOrder New roles sort order.
* @param BoolType $unknownReadingGranted Value of the reading permission for unknown groups.
* @param BoolType $unknownWritingGranted Value of the writing permission for unknown groups.
* @param BoolType $unknownDeletingGranted Value of the deleting permission for unknown groups.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function updateRoleById(IdType $roleId,
KeyValueCollection $newName,
KeyValueCollection $newDescription,
IntType $newSortOrder,
BoolType $unknownReadingGranted,
BoolType $unknownWritingGranted,
BoolType $unknownDeletingGranted);
/**
* Deletes role by a given role ID.
*
* @param IdType $roleId ID of the role that should be deleted.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function deleteRoleById(IdType $roleId);
/**
* Returns a collection of all roles.
*
* @return AdminAccessRoleCollection Role collection with all available roles.
*/
public function getAllRoles();
/**
* Deletes an admin access user by a given customer ID.
*
* @param IdType $customerId ID of the user that should be deleted.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*/
public function deleteUserByCustomerId(IdType $customerId);
/**
* Returns a role by a given role ID.
*
* @param IdType $roleId ID of the requested role.
*
* @return \AdminAccessRoleInterface
*/
public function getRoleById(IdType $roleId);
/**
* Returns a collection of permissions of a role by a given group collection.
*
* @param IdType $roleId Role ID.
* @param AdminAccessGroupCollection $groupCollection Group collection.
*
* @return AdminAccessPermissionCollection Permission collection object with all role permissions.
*/
public function getPermissionsByGroupCollection(IdType $roleId, AdminAccessGroupCollection $groupCollection);
/**
* Returns a collection of all groups.
*
* @return AdminAccessGroupCollection Group collection.
*/
public function getAllGroups();
/**
* Returns a group by a given controller identifier.
*
* @param \NonEmptyStringType $identifier Controller identifier.
*
* @return \AdminAccessGroupInterface Group object.
*
* @throws \GroupNotFoundException
*/
public function getGroupByController(NonEmptyStringType $identifier);
/**
* Returns a group by a given page identifier.
*
* @param \NonEmptyStringType $identifier Page identifier.
*
* @return \AdminAccessGroupInterface Group object.
*
* @throws \GroupNotFoundException
*/
public function getGroupByPage(NonEmptyStringType $identifier);
/**
* Returns a group by a given ajax handler identifier.
*
* @param \NonEmptyStringType $identifier Ajax handler identifier.
*
* @return \AdminAccessGroupInterface Group object.
*
* @throws \GroupNotFoundException
*/
public function getGroupByAjaxHandler(NonEmptyStringType $identifier);
/**
* Returns a group by a given group id.
*
* @param IdType $id Group id.
*
* @return \AdminAccessGroupInterface Group object.
*
* @throws \GroupNotFoundException
*/
public function getGroupById(IdType $id);
/**
* Adds a group item to an existing group.
*
* @param \IdType $groupId Id of the group.
* @param \NonEmptyStringType $identifier Identifier for this item.
* @param \NonEmptyStringType $type Type of this item.
*
* @return \AdminAccessGroupInterface Group object.
*
* @throws \GroupNotFoundException
*/
public function addItemToGroup(IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type);
/**
* Removes a group item from an existing group.
*
* @param \IdType $groupId Id of the group.
* @param \NonEmptyStringType $identifier Identifier for this item.
* @param \NonEmptyStringType $type Type of this item.
*
* @return \AdminAccessGroupInterface Group object.
*
* @throws \GroupNotFoundException
* @throws \GroupItemNotFoundInCollectionException
*/
public function removeItemFromGroup(IdType $groupId, NonEmptyStringType $identifier, NonEmptyStringType $type);
/**
* Creates a new group.
*
* @param KeyValueCollection $name Collection with the group names. Index of a group name must be his
* language code.
* @param KeyValueCollection $description Collection with the group descriptions. Index of a group name must be his
* language code.
* @param IdType $parentId Id of the parent group.
* @param IntType $sortOrder Group sorts order.
*
* @return AdminAccessGroupInterface Returns the create role.
*
* @throws \GroupNotFoundException
*/
public function createNewGroup(KeyValueCollection $name,
KeyValueCollection $description,
IdType $parentId,
IntType $sortOrder);
/**
* Updates a group by a given group ID.
*
* @param KeyValueCollection $newName Collection with the group names. Index of a group name must be his
* language code.
* @param KeyValueCollection $newDescription Collection with the group descriptions. Index of a group name must be
* his language code.
* @param IdType $newParentId New id of the parent group.
* @param IntType $newSortOrder New group sorts order.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*
* @throws \GroupNotFoundException
*/
public function updateGroup(IdType $id,
KeyValueCollection $newName,
KeyValueCollection $newDescription,
IdType $newParentId,
IntType $newSortOrder);
/**
* Deletes a group by a given group ID.
*
* @param IdType $id ID of the group that should be deleted.
*
* @return AdminAccessServiceInterface Returns same instance for chained method calls.
*
* @throws \GroupNotFoundException
*/
public function deleteGroupById(IdType $id);
}