API Documentation
Back to top  

AdminAccessGroupReader

Implements \AdminAccessGroupReaderInterface

Class AdminAccessGroupReader

category

System
package

AdminAccess
subpackage

Readers

Methods

AdminAccessGroupReader constructor.

__construct(\CI_DB_query_builder $queryBuilder, \AdminAccessGroupFactoryInterface $accessGroupFactory, \LanguageProviderInterface $languageProvider)

Arguments

$queryBuilder

\CI_DB_query_builder

Query builder.

$accessGroupFactory

\AdminAccessGroupFactoryInterface

Access group factory.

$languageProvider

\LanguageProviderInterface

Language provider.

Returns a AdminAccessGroup object, created from an array with the group data.

_createAdminAccessGroupByArray(array $groupData) : \AdminAccessGroupInterface

Arguments

$groupData

array

Group data.

Response

\AdminAccessGroupInterface

Group object.

Returns the group descriptions that were queried from the database.

_getGroupItemsData(integer $groupId) : array

Arguments

$groupId

integer

Group ID.

Response

array

Array with group meta data.

Returns the group descriptions that were queried from the database.

_getGroupMetaData(integer $groupId) : array

Arguments

$groupId

integer

Group ID.

Response

array

Array with group meta data.

Returns an AdminAccessGroupCollection with all existing AdminAccessGroup objects.

getAll() : \AdminAccessGroupCollection

Response

\AdminAccessGroupCollection

Group collection with all available groups.

Returns an AdminAccessGroup instance by the given ajax handler identifier.

getByAjaxHandler(\NonEmptyStringType $identifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

If group not found.

Arguments

$identifier

\NonEmptyStringType

Identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroup instance by the given group identifier.

getByController(\NonEmptyStringType $controllerIdentifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$controllerIdentifier

\NonEmptyStringType

Controller identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroup instance by the given AccessGroup ID.

getById(\IdType $groupId) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

Arguments

$groupId

\IdType

Group ID.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroup instance by the given page identifier.

getByPage(\NonEmptyStringType $pageIdentifier) : \AdminAccessGroupInterface
Throws
\GroupNotFoundException

If group not found.

Arguments

$pageIdentifier

\NonEmptyStringType

Page identifier.

Response

\AdminAccessGroupInterface

Group object.

Returns an AdminAccessGroupCollection instance with all child groups for the given group ID.

getChildren(\IdType $groupId) : \AdminAccessGroupCollection

Arguments

$groupId

\IdType

Group ID.

Response

\AdminAccessGroupCollection

Group collection.

Properties

queryBuilder

queryBuilder : \CI_DB_query_builder
var

Type(s)

\CI_DB_query_builder

factory

factory : \AdminAccessGroupFactoryInterface
var

Type(s)

\AdminAccessGroupFactoryInterface

controllerType

controllerType : string
var

Type(s)

string

pageType

pageType : string
var

Type(s)

string

ajaxHandlerType

ajaxHandlerType : string
var

Type(s)

string

adminAccessGroupsTable

adminAccessGroupsTable : string
var

Type(s)

string

adminAccessGroupItemsTable

adminAccessGroupItemsTable : string
var

Type(s)

string

adminAccessGroupsDescriptionsTable

adminAccessGroupsDescriptionsTable : string
var

Type(s)

string

languageProvider

languageProvider : \LanguageProviderInterface
var

Type(s)

\LanguageProviderInterface