PHP Класс LdapTools\Query\OperatorCollection

Автор: Chad Sikorra ([email protected])
Наследование: implements IteratorAggregate
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$aliases An array mapping of alias names to schema objects.
$operators Contains the various Operator objects grouped by their type.
$schema Contains the LdapObjectSchema objects

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

Метод Описание
__clone ( ) When an operation collection is cloned, we want to make sure the operator objects are cloned as well.
add ( variadic $operators ) Add an Operator to the collection.
addLdapObjectSchema ( LdapObjectSchema $schema, null | string $alias = null ) Add a LdapObjectSchema for a object type that will be selected for. Optionally specify a specific alias that is used to reference it. If no alias is specified, then it uses the object type name for the schema.
getAliases ( ) : string[] Get the aliases in the form of ['alias' => LdapObjectSchema]
getAndOperators ( ) : bAnd[] Get all the 'bAnd' Operators.
getComparisonOperators ( ) : Comparison[] Get all the 'Comparison' Operators.
getIterator ( ) : ArrayIterator Allows this object to be iterated over.
getMatchingRuleOperators ( ) : MatchingRule[] Get all the 'MatchingRule' Operators.
getNotOperators ( ) : bNot[] Get all the 'bNot' Operators.
getOrOperators ( ) : bOr[] Get all the 'bOr' Operators.
getWildcardOperators ( ) : Wildcard[] Get all the 'Wildcard' Operators.
toArray ( ) : BaseOperator[] Get all the Operators sorted into a single array.
toLdapFilter ( string | null $alias = null ) : string Get the LDAP filter string representation of all the operators in the collection.

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

Метод Описание
getLdapFilter ( $alias )
getLdapFilterForAliases ( ) : string Constructs a filter for multiple aliases that would return the requested LDAP objects in a single query.
sortOperatorsToArray ( ) : BaseOperator[] Merges all the Operators into one large array in a specific order. Before doing so, it will apply any schemas that exist.

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

__clone() публичный метод

When an operation collection is cloned, we want to make sure the operator objects are cloned as well.
public __clone ( )

add() публичный метод

Add an Operator to the collection.
public add ( variadic $operators )
$operators variadic

addLdapObjectSchema() публичный метод

Add a LdapObjectSchema for a object type that will be selected for. Optionally specify a specific alias that is used to reference it. If no alias is specified, then it uses the object type name for the schema.
public addLdapObjectSchema ( LdapObjectSchema $schema, null | string $alias = null )
$schema LdapTools\Schema\LdapObjectSchema
$alias null | string

getAliases() публичный метод

Get the aliases in the form of ['alias' => LdapObjectSchema]
public getAliases ( ) : string[]
Результат string[]

getAndOperators() публичный метод

Get all the 'bAnd' Operators.
public getAndOperators ( ) : bAnd[]
Результат LdapTools\Query\Operator\bAnd[]

getComparisonOperators() публичный метод

Get all the 'Comparison' Operators.
public getComparisonOperators ( ) : Comparison[]
Результат LdapTools\Query\Operator\Comparison[]

getIterator() публичный метод

Allows this object to be iterated over.
public getIterator ( ) : ArrayIterator
Результат ArrayIterator

getLdapFilter() защищенный метод

protected getLdapFilter ( $alias )

getLdapFilterForAliases() защищенный метод

Constructs a filter for multiple aliases that would return the requested LDAP objects in a single query.
protected getLdapFilterForAliases ( ) : string
Результат string

getMatchingRuleOperators() публичный метод

Get all the 'MatchingRule' Operators.
public getMatchingRuleOperators ( ) : MatchingRule[]
Результат LdapTools\Query\Operator\MatchingRule[]

getNotOperators() публичный метод

Get all the 'bNot' Operators.
public getNotOperators ( ) : bNot[]
Результат LdapTools\Query\Operator\bNot[]

getOrOperators() публичный метод

Get all the 'bOr' Operators.
public getOrOperators ( ) : bOr[]
Результат LdapTools\Query\Operator\bOr[]

getWildcardOperators() публичный метод

Get all the 'Wildcard' Operators.
public getWildcardOperators ( ) : Wildcard[]
Результат LdapTools\Query\Operator\Wildcard[]

sortOperatorsToArray() защищенный метод

Merges all the Operators into one large array in a specific order. Before doing so, it will apply any schemas that exist.
protected sortOperatorsToArray ( ) : BaseOperator[]
Результат LdapTools\Query\Operator\BaseOperator[]

toArray() публичный метод

Get all the Operators sorted into a single array.
public toArray ( ) : BaseOperator[]
Результат LdapTools\Query\Operator\BaseOperator[]

toLdapFilter() публичный метод

Get the LDAP filter string representation of all the operators in the collection.
public toLdapFilter ( string | null $alias = null ) : string
$alias string | null The alias to narrow the filter to.
Результат string

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

$aliases защищенное свойство

An array mapping of alias names to schema objects.
protected $aliases

$operators защищенное свойство

Contains the various Operator objects grouped by their type.
protected $operators

$schema защищенное свойство

Contains the LdapObjectSchema objects
protected $schema