PHP Класс LdapTools\Query\Builder\FilterBuilder

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

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

Метод Описание
aeq ( $attribute, $value ) : Comparison An approximately-equal-to comparison.
bAnd ( $op ) : bAnd A logical AND operator.
bNot ( BaseOperator $op ) : bNot A logical NOT operator.
bOr ( $op ) : bOr A logical OR operator.
bitwiseAnd ( string $attribute, integer $value ) : MatchingRule Perform a bitwise AND operation against an attribute.
bitwiseOr ( string $attribute, integer $value ) : MatchingRule Perform a bitwise OR operation against an attribute.
contains ( $attribute, $value ) : Wildcard Encapsulates the search term with a wildcard on each end.
endsWith ( $attribute, $value ) : Wildcard Places a wildcard at the beginning of the search term.
eq ( $attribute, $value ) : Comparison An equal-to comparison.
getInstance ( LdapTools\Connection\LdapConnectionInterface $connection = null ) : ADFilterBuilder | FilterBuilder Get a FilterBuilder instance based on the connection.
gt ( string $attribute, mixed $value ) : bAnd A greater-than comparison. Since an actual '>' operator does not exist in LDAP, this is a combination of a less-than-or-equal-to operator along with a check if the attribute is set/present. This is encapsulated within a logical 'AND' operator.
gte ( $attribute, $value ) : Comparison A greater-than-or-equal-to comparison.
like ( $attribute, $value ) : Wildcard Do not escape wildcard characters in the value, but will escape all other characters. This allows for searches That may need several arbitrarily placed wildcards (ie. sn=Th*m*s)
lt ( string $attribute, mixed $value ) : bAnd A less-than comparison. Since an actual '<' operator does not exist in LDAP, this is a combination of a greater-than-or-equal-to operator along with a check if the attribute is set/present. This is encapsulated within a logical 'AND' operator.
lte ( $attribute, $value ) : Comparison A less-than-or-equal-to comparison.
neq ( $attribute, $value ) : bNot A convenience method for a not-equal-to comparison.
notPresent ( $attribute ) : bNot Convenience method to check for the non-existence of an attribute.
present ( $attribute ) : Wildcard Checks for the existence of an attribute.
startsWith ( $attribute, $value ) : Wildcard Places a wildcard at the end of the search term.

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

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

An approximately-equal-to comparison.
public aeq ( $attribute, $value ) : Comparison
$attribute
$value
Результат LdapTools\Query\Operator\Comparison

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

A logical AND operator.
public bAnd ( $op ) : bAnd
Результат LdapTools\Query\Operator\bAnd

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

A logical NOT operator.
public bNot ( BaseOperator $op ) : bNot
$op LdapTools\Query\Operator\BaseOperator
Результат LdapTools\Query\Operator\bNot

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

A logical OR operator.
public bOr ( $op ) : bOr
Результат LdapTools\Query\Operator\bOr

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

Perform a bitwise AND operation against an attribute.
public bitwiseAnd ( string $attribute, integer $value ) : MatchingRule
$attribute string
$value integer
Результат LdapTools\Query\Operator\MatchingRule

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

Perform a bitwise OR operation against an attribute.
public bitwiseOr ( string $attribute, integer $value ) : MatchingRule
$attribute string
$value integer
Результат LdapTools\Query\Operator\MatchingRule

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

Encapsulates the search term with a wildcard on each end.
public contains ( $attribute, $value ) : Wildcard
$attribute
$value
Результат LdapTools\Query\Operator\Wildcard

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

Places a wildcard at the beginning of the search term.
public endsWith ( $attribute, $value ) : Wildcard
$attribute
$value
Результат LdapTools\Query\Operator\Wildcard

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

An equal-to comparison.
public eq ( $attribute, $value ) : Comparison
$attribute
$value
Результат LdapTools\Query\Operator\Comparison

getInstance() публичный статический метод

Get a FilterBuilder instance based on the connection.
public static getInstance ( LdapTools\Connection\LdapConnectionInterface $connection = null ) : ADFilterBuilder | FilterBuilder
$connection LdapTools\Connection\LdapConnectionInterface
Результат ADFilterBuilder | FilterBuilder

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

A greater-than comparison. Since an actual '>' operator does not exist in LDAP, this is a combination of a less-than-or-equal-to operator along with a check if the attribute is set/present. This is encapsulated within a logical 'AND' operator.
public gt ( string $attribute, mixed $value ) : bAnd
$attribute string
$value mixed
Результат LdapTools\Query\Operator\bAnd

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

A greater-than-or-equal-to comparison.
public gte ( $attribute, $value ) : Comparison
$attribute
$value
Результат LdapTools\Query\Operator\Comparison

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

Do not escape wildcard characters in the value, but will escape all other characters. This allows for searches That may need several arbitrarily placed wildcards (ie. sn=Th*m*s)
public like ( $attribute, $value ) : Wildcard
$attribute
$value
Результат LdapTools\Query\Operator\Wildcard

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

A less-than comparison. Since an actual '<' operator does not exist in LDAP, this is a combination of a greater-than-or-equal-to operator along with a check if the attribute is set/present. This is encapsulated within a logical 'AND' operator.
public lt ( string $attribute, mixed $value ) : bAnd
$attribute string
$value mixed
Результат LdapTools\Query\Operator\bAnd

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

A less-than-or-equal-to comparison.
public lte ( $attribute, $value ) : Comparison
$attribute
$value
Результат LdapTools\Query\Operator\Comparison

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

A convenience method for a not-equal-to comparison.
public neq ( $attribute, $value ) : bNot
$attribute
$value
Результат LdapTools\Query\Operator\bNot

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

Convenience method to check for the non-existence of an attribute.
public notPresent ( $attribute ) : bNot
$attribute
Результат LdapTools\Query\Operator\bNot

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

Checks for the existence of an attribute.
public present ( $attribute ) : Wildcard
$attribute
Результат LdapTools\Query\Operator\Wildcard

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

Places a wildcard at the end of the search term.
public startsWith ( $attribute, $value ) : Wildcard
$attribute
$value
Результат LdapTools\Query\Operator\Wildcard