AdminAccessPermissionReader
in package
implements
AdminAccessPermissionReaderInterface
Class AdminAccessPermissionReader
Tags
Interfaces, Classes and Traits
- AdminAccessPermissionReaderInterface
- Interface AdminAccessPermissionReaderInterface
Table of Contents
- $permissionFactory : AdminAccessPermissionFactoryInterface
- $permissionTable : string
- $queryBuilder : CI_DB_query_builder
- __construct() : mixed
- AdminAccessPermissionReader constructor.
- get() : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface|null
- Returns an AdminAccessPermission object by given AdminAccessRole and AdminAccessGroup objects.
- getByGroupCollection() : AdminAccessPermissionCollection
- Returns an AdminAccessPermissionCollection by a given AdminAccessRole and AdminAccessGroupCollection object.
- _createPermissionObject() : AdminAccessPermissionPersistenceInterface|AdminAccessPermissionPresentationInterface
- Returns an AdminAccessPermission objects, that gets its property values from permission data array.
Properties
$permissionFactory
protected
AdminAccessPermissionFactoryInterface
$permissionFactory
$permissionTable
protected
string
$permissionTable
$queryBuilder
protected
CI_DB_query_builder
$queryBuilder
Methods
__construct()
AdminAccessPermissionReader constructor.
public
__construct(CI_DB_query_builder $queryBuilder, AdminAccessPermissionFactoryInterface $permissionFactory) : mixed
Parameters
- $queryBuilder : CI_DB_query_builder
-
Query builder.
- $permissionFactory : AdminAccessPermissionFactoryInterface
-
Permission factory.
Return values
mixed —get()
Returns an AdminAccessPermission object by given AdminAccessRole and AdminAccessGroup objects.
public
get(AdminAccessRoleInterface $accessRole, AdminAccessGroupInterface $accessGroup) : AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface|null
Parameters
- $accessRole : AdminAccessRoleInterface
-
Role object.
- $accessGroup : AdminAccessGroupInterface
-
Group object.
Return values
AdminAccessPermissionPresentationInterface|AdminAccessPermissionPersistenceInterface|null —Permission object or null if permission not found.
getByGroupCollection()
Returns an AdminAccessPermissionCollection by a given AdminAccessRole and AdminAccessGroupCollection object.
public
getByGroupCollection(AdminAccessRoleInterface $accessRole, AdminAccessGroupCollection $groupCollection) : AdminAccessPermissionCollection
Parameters
- $accessRole : AdminAccessRoleInterface
-
User role to find permission for.
- $groupCollection : AdminAccessGroupCollection
-
Collection of all groups in system.
Return values
AdminAccessPermissionCollection —Permission collection.
_createPermissionObject()
Returns an AdminAccessPermission objects, that gets its property values from permission data array.
protected
_createPermissionObject(array<string|int, mixed>|null $permissionData, AdminAccessRoleInterface $role, AdminAccessGroupInterface $group) : AdminAccessPermissionPersistenceInterface|AdminAccessPermissionPresentationInterface
Parameters
- $permissionData : array<string|int, mixed>|null
-
Permission data.
- $role : AdminAccessRoleInterface
-
Role needed to create permission object.
- $group : AdminAccessGroupInterface
-
Group needed to create permission object.
Return values
AdminAccessPermissionPersistenceInterface|AdminAccessPermissionPresentationInterface —Permission object.