AdminAccessGroupReader
in package
implements
AdminAccessGroupReaderInterface
Class AdminAccessGroupReader
Tags
Interfaces, Classes and Traits
- AdminAccessGroupReaderInterface
- Interface AdminAccessGroupReaderInterface
Table of Contents
- $adminAccessGroupItemsTable : string
- $adminAccessGroupsDescriptionsTable : string
- $adminAccessGroupsTable : string
- $ajaxHandlerType : string
- $controllerType : string
- $factory : AdminAccessGroupFactoryInterface
- $languageProvider : LanguageProviderInterface
- $pageType : string
- $queryBuilder : CI_DB_query_builder
- __construct() : mixed
- AdminAccessGroupReader constructor.
- getAll() : AdminAccessGroupCollection
- Returns an AdminAccessGroupCollection with all existing AdminAccessGroup objects.
- getByAjaxHandler() : AdminAccessGroupInterface
- Returns an AdminAccessGroup instance by the given ajax handler identifier.
- getByController() : AdminAccessGroupInterface
- Returns an AdminAccessGroup instance by the given group identifier.
- getById() : AdminAccessGroupInterface
- Returns an AdminAccessGroup instance by the given AccessGroup ID.
- getByPage() : AdminAccessGroupInterface
- Returns an AdminAccessGroup instance by the given page identifier.
- getChildren() : AdminAccessGroupCollection
- Returns an AdminAccessGroupCollection instance with all child groups for the given group ID.
- _createAdminAccessGroupByArray() : AdminAccessGroupInterface
- Returns a AdminAccessGroup object, created from an array with the group data.
- _getGroupItemsData() : array<string|int, mixed>
- Returns the group descriptions that were queried from the database.
- _getGroupMetaData() : array<string|int, mixed>
- Returns the group descriptions that were queried from the database.
Properties
$adminAccessGroupItemsTable
protected
string
$adminAccessGroupItemsTable
$adminAccessGroupsDescriptionsTable
protected
string
$adminAccessGroupsDescriptionsTable
$adminAccessGroupsTable
protected
string
$adminAccessGroupsTable
$ajaxHandlerType
protected
string
$ajaxHandlerType
$controllerType
protected
string
$controllerType
$factory
protected
AdminAccessGroupFactoryInterface
$factory
$languageProvider
protected
LanguageProviderInterface
$languageProvider
$pageType
protected
string
$pageType
$queryBuilder
protected
CI_DB_query_builder
$queryBuilder
Methods
__construct()
AdminAccessGroupReader constructor.
public
__construct(CI_DB_query_builder $queryBuilder, AdminAccessGroupFactoryInterface $accessGroupFactory, LanguageProviderInterface $languageProvider) : mixed
Parameters
- $queryBuilder : CI_DB_query_builder
-
Query builder.
- $accessGroupFactory : AdminAccessGroupFactoryInterface
-
Access group factory.
- $languageProvider : LanguageProviderInterface
-
Language provider.
Return values
mixed —getAll()
Returns an AdminAccessGroupCollection with all existing AdminAccessGroup objects.
public
getAll() : AdminAccessGroupCollection
Return values
AdminAccessGroupCollection —Group collection with all available groups.
getByAjaxHandler()
Returns an AdminAccessGroup instance by the given ajax handler identifier.
public
getByAjaxHandler(NonEmptyStringType $identifier) : AdminAccessGroupInterface
Parameters
- $identifier : NonEmptyStringType
-
Identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getByController()
Returns an AdminAccessGroup instance by the given group identifier.
public
getByController(NonEmptyStringType $controllerIdentifier) : AdminAccessGroupInterface
Parameters
- $controllerIdentifier : NonEmptyStringType
-
Controller identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getById()
Returns an AdminAccessGroup instance by the given AccessGroup ID.
public
getById(IdType $groupId) : AdminAccessGroupInterface
Parameters
- $groupId : IdType
-
Group ID.
Tags
Return values
AdminAccessGroupInterface —Group object.
getByPage()
Returns an AdminAccessGroup instance by the given page identifier.
public
getByPage(NonEmptyStringType $pageIdentifier) : AdminAccessGroupInterface
Parameters
- $pageIdentifier : NonEmptyStringType
-
Page identifier.
Tags
Return values
AdminAccessGroupInterface —Group object.
getChildren()
Returns an AdminAccessGroupCollection instance with all child groups for the given group ID.
public
getChildren(IdType $groupId) : AdminAccessGroupCollection
Parameters
- $groupId : IdType
-
Group ID.
Return values
AdminAccessGroupCollection —Group collection.
_createAdminAccessGroupByArray()
Returns a AdminAccessGroup object, created from an array with the group data.
protected
_createAdminAccessGroupByArray(array<string|int, mixed> $groupData) : AdminAccessGroupInterface
Parameters
- $groupData : array<string|int, mixed>
-
Group data.
Return values
AdminAccessGroupInterface —Group object.
_getGroupItemsData()
Returns the group descriptions that were queried from the database.
protected
_getGroupItemsData(int $groupId) : array<string|int, mixed>
Parameters
- $groupId : int
-
Group ID.
Return values
array<string|int, mixed> —Array with group meta data.
_getGroupMetaData()
Returns the group descriptions that were queried from the database.
protected
_getGroupMetaData(int $groupId) : array<string|int, mixed>
Parameters
- $groupId : int
-
Group ID.
Return values
array<string|int, mixed> —Array with group meta data.