AdminAccessRoleReader
in package
implements
AdminAccessRoleReaderInterface
Class AdminAccessRoleReader
Tags
Interfaces, Classes and Traits
- AdminAccessRoleReaderInterface
- Interface AdminAccessRoleReaderInterface
Table of Contents
- $customersTable : string
- $languageProvider : LanguageProviderInterface
- $queryBuilder : CI_DB_query_builder
- $roleFactory : AdminAccessRoleFactoryInterface
- $rolesMetaTable : string
- $rolesTable : string
- __construct() : mixed
- AdminAccessRoleReader constructor.
- getAll() : AdminAccessRoleCollection
- Returns all roles of a certain user by a given customer ID.
- getByCustomerId() : AdminAccessRoleCollection
- Returns a role object by a given role ID.
- getById() : AdminAccessRoleInterface
- Returns all available roles as a role collection.
- _createAdminAccessRoleByArray() : AdminAccessRoleInterface
- Creates a role object by a given array with the role data.
- _getRoleMetaData() : array<string|int, mixed>
- Returns the role descriptions from the database.
Properties
$customersTable
protected
string
$customersTable
$languageProvider
protected
LanguageProviderInterface
$languageProvider
$queryBuilder
protected
CI_DB_query_builder
$queryBuilder
$roleFactory
protected
AdminAccessRoleFactoryInterface
$roleFactory
$rolesMetaTable
protected
string
$rolesMetaTable
$rolesTable
protected
string
$rolesTable
Methods
__construct()
AdminAccessRoleReader constructor.
public
__construct(CI_DB_query_builder $queryBuilder, AdminAccessRoleFactoryInterface $roleFactory, LanguageProviderInterface $languageProvider) : mixed
Parameters
- $queryBuilder : CI_DB_query_builder
-
Query builder.
- $roleFactory : AdminAccessRoleFactoryInterface
-
Role Factory.
- $languageProvider : LanguageProviderInterface
-
Language provider.
Return values
mixed —getAll()
Returns all roles of a certain user by a given customer ID.
public
getAll() : AdminAccessRoleCollection
Return values
AdminAccessRoleCollection —Role collection with all available roles.
getByCustomerId()
Returns a role object by a given role ID.
public
getByCustomerId(IdType $customerId) : AdminAccessRoleCollection
Parameters
- $customerId : IdType
-
Customer ID.
Tags
Return values
AdminAccessRoleCollection —Role collection with all roles of a certain user.
getById()
Returns all available roles as a role collection.
public
getById(IdType $roleId) : AdminAccessRoleInterface
Parameters
- $roleId : IdType
-
Role ID.
Tags
Return values
AdminAccessRoleInterface —Role object.
_createAdminAccessRoleByArray()
Creates a role object by a given array with the role data.
protected
_createAdminAccessRoleByArray(array<string|int, mixed> $roleData) : AdminAccessRoleInterface
Parameters
- $roleData : array<string|int, mixed>
-
Role data.
Return values
AdminAccessRoleInterface —Role object.
_getRoleMetaData()
Returns the role descriptions from the database.
protected
_getRoleMetaData(int $roleId) : array<string|int, mixed>
Parameters
- $roleId : int
-
Role ID.
Return values
array<string|int, mixed> —Array with role descriptions.