LdapiBehavior
extends Behavior
in package
LdapiBehavior behavior
Possible options:
-
fields.user=> Column containing LDAPUser id (default: 'user_id') -
fields.committee=> Column containing LDAPCommittee id (default: 'committee_id') -
entities.user=> Key used to store LDAPUser (default: 'user') -
entities.committee=> Key used to store LDAPCommittee (default: 'committee')
Table of Contents
- $_defaultConfig : array<string|int, mixed>
- Default configuration.
- $_association : string
- The field used during *the current query*
- findWithCommittees() : Query
- Include LDAPCommittee objects through LDAPI
- findWithUsers() : Query
- Include LDAPUser objects through LDAPI
- formatterObjects() : CollectionInterface
- Takes in the results collection of a ORM query and process the results
Properties
$_defaultConfig
Default configuration.
protected
array<string|int, mixed>
$_defaultConfig
= ['fields' => ['user' => 'user_id', 'committee' => 'committee_id'], 'entities' => ['user' => 'user', 'committee' => 'committee']]
$_association
The field used during *the current query*
private
string
$_association
= false
This is a property so it is easily shared amongst embedded methods.
Methods
findWithCommittees()
Include LDAPCommittee objects through LDAPI
public
findWithCommittees(Query $query, array<string|int, mixed> $options) : Query
This makes use of the user and entity config options.
Parameters
- $query : Query
- $options : array<string|int, mixed>
Return values
Query —findWithUsers()
Include LDAPUser objects through LDAPI
public
findWithUsers(Query $query, array<string|int, mixed> $options) : Query
This makes use of the user and entity config options.
Parameters
- $query : Query
- $options : array<string|int, mixed>
Return values
Query —formatterObjects()
Takes in the results collection of a ORM query and process the results
public
formatterObjects(CollectionInterface $results) : CollectionInterface
Returns a modified collection, in this case included with LDAPI objects.
Parameters
- $results : CollectionInterface