Свойство | Type | Description | |
---|---|---|---|
$caseSensitive | boolean | ||
$hydratorFactory | |||
$ldap | LdapTools\Connection\LdapConnectionInterface | ||
$operation | |||
$orderBy | The attributes to order by, if any. They will be in ['attribute' => 'ASC'] form. | ||
$schemas |
Méthode | Description | |
---|---|---|
__construct ( LdapTools\Connection\LdapConnectionInterface $ldap ) | ||
execute ( string $hydratorType = HydratorFactory::TO_OBJECT ) : mixed | Execute a query based on the set parameters. Optionally choose a mode to hydrate the results in. | |
getArrayResult ( ) : array | This is an alias for the execute() method with an implied array hydration type. This executes the query against LDAP and returns the results as an array instead of objects. | |
getIsCaseSensitiveSort ( ) : boolean | Get whether or not the results should be sorted in a case-sensitive way. | |
getOneOrNullResult ( string $hydratorType = HydratorFactory::TO_OBJECT ) : array | |
This behaves very similar to getSingleResult(), only if no results are found it will return null instead of throwing an exception. | |
getOrderBy ( ) : array | Get the attributes to order the results by. | |
getQueryOperation ( ) : |
Get the query operation that will run against LDAP. | |
getResult ( string $hydratorType = HydratorFactory::TO_OBJECT ) : mixed | This is an alias for the execute() method. This executes the query against LDAP and returns the result. | |
getSingleResult ( string $hydratorType = HydratorFactory::TO_OBJECT ) : array | |
Retrieve a single unique result from LDAP. If the result is empty or contains more than one entry, an exception is thrown. | |
getSingleScalarOrNullResult ( ) : mixed | This behaves very similar to getSingleScalarResult(), only if the attribute is not found it will return null instead of throwing an exception. | |
getSingleScalarResult ( ) : mixed | Retrieve a single selected attribute value from LDAP. | |
setIsCaseSensitiveSort ( boolean $caseSensitive ) | Set whether or not the results should be sorted in a case-sensitive way. | |
setOrderBy ( array $orderBy ) | Set the attributes to order the results by. | |
setQueryOperation ( |
Set the query operation to run against LDAP. |
Méthode | Description | |
---|---|---|
getFormattedOrderBy ( $selected, $aliases ) : array | This formats the orderBy array to ignore case differences between the orderBy name and the actually selected name, such as for sorting arrays. | |
getResultsForAliases ( string $hydratorType ) : array | |
Goes through each alias for the operation to get results only for that specific type, then combine and return them all. | |
getResultsFromLdap ( |
||
getSelectedForAllAliases ( array $aliases ) : array | Get all the attributes that were selected for the query taking into account all of the aliases used. | |
sortResults ( mixed $results ) : mixed |
public __construct ( LdapTools\Connection\LdapConnectionInterface $ldap ) | ||
$ldap | LdapTools\Connection\LdapConnectionInterface |
public getArrayResult ( ) : array | ||
Résultat | array |
protected getFormattedOrderBy ( $selected, $aliases ) : array | ||
$selected | ||
$aliases | ||
Résultat | array |
public getIsCaseSensitiveSort ( ) : boolean | ||
Résultat | boolean |
public getOrderBy ( ) : array | ||
Résultat | array |
public getQueryOperation ( ) : |
||
Résultat |
protected getResultsFromLdap ( |
||
$operation | ||
$hydratorType | string | |
$schema | null | |
|
$alias | null | string | |
Résultat | mixed |
protected getSelectedForAllAliases ( array $aliases ) : array | ||
$aliases | array | |
Résultat | array |
public getSingleResult ( string $hydratorType = HydratorFactory::TO_OBJECT ) : array | |
||
$hydratorType | string | A hyrdrator type constant from the factory. |
Résultat | array | |
public getSingleScalarOrNullResult ( ) : mixed | ||
Résultat | mixed |
public getSingleScalarResult ( ) : mixed | ||
Résultat | mixed |
public setIsCaseSensitiveSort ( boolean $caseSensitive ) | ||
$caseSensitive | boolean |
public setOrderBy ( array $orderBy ) | ||
$orderBy | array | In the form of ['attribute' => 'ASC', ...] |
public setQueryOperation ( |
||
$operation |
protected sortResults ( mixed $results ) : mixed | ||
$results | mixed | |
Résultat | mixed | $results |
protected HydratorFactory,LdapTools\Factory $hydratorFactory | ||
Résultat |
protected LdapConnectionInterface,LdapTools\Connection $ldap | ||
Résultat | LdapTools\Connection\LdapConnectionInterface |
protected QueryOperation,LdapTools\Operation|null $operation | ||
Résultat |
protected $orderBy |