• Главная
• LdapTools
• Query
• LdapQuery

PHP Класс LdapTools\Query\LdapQuery

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$caseSensitive	boolean
$hydratorFactory	LdapTools\Factory\HydratorFactory
$ldap	LdapTools\Connection\LdapConnectionInterface
$operation	LdapTools\Operation\QueryOperation | null
$orderBy		The attributes to order by, if any. They will be in ['attribute' => 'ASC'] form.
$schemas	LdapTools\Schema\LdapObjectSchema[]

Открытые методы

Метод	Описание
__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 | LdapObject | null	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 ( ) : QueryOperation | null	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 | LdapObject	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 ( QueryOperation $operation )	Set the query operation to run against LDAP.

Защищенные методы

Метод	Описание
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 | LdapObjectCollection | mixed	Goes through each alias for the operation to get results only for that specific type, then combine and return them all.
getResultsFromLdap ( QueryOperation $operation, string $hydratorType, null | LdapObjectSchema $schema = null, null | string $alias = null ) : mixed
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

Описание методов

Описание свойств