Zend\Ldap\Filter\StringFilter provides a simple custom string filter.

category Zend
package Zend_Ldap
subpackage Filter

 Methods

Creates a Zend\Ldap\Filter\StringFilter.

__construct(string $filter) 

Parameters

$filter

string

Returns a string representation of the filter.

__toString() : string
Inherited

see \Zend\Ldap\Filter\toString()
inherited_from \Zend\Ldap\Filter\AbstractFilter::__toString()

Returns

string

Creates an 'and' filter.

addAnd($filter) : \Zend\Ldap\Filter\AndFilter
Inherited

inherited_from \Zend\Ldap\Filter\AbstractFilter::addAnd()

Parameters

$filter

Returns

Creates an 'or' filter.

addOr($filter) : \Zend\Ldap\Filter\OrFilter
Inherited

inherited_from \Zend\Ldap\Filter\AbstractFilter::addOr()

Parameters

$filter

Returns

Escapes the given VALUES according to RFC 2254 so that they can be safely used in LDAP filters.

escapeValue(string | array $values) : array
Inherited

Any control characters with an ACII code < 32 as well as the characters with special meaning in LDAP filters "*", "(", ")", and "\" (the backslash) are converted into the representation of a backslash followed by two hex digits representing the hexadecimal value of the character.

see \Zend\Ldap\Filter\Net_LDAP2_Util::escape_filter_value()
link http://pear.php.net/package/Net_LDAP2
author Benedikt Hallinger
inherited_from \Zend\Ldap\Filter\AbstractFilter::escapeValue()

Parameters

$values

stringarray

Array of values to escape

Returns

arrayArray $values, but escaped

Negates the filter.

negate() : \Zend\Ldap\Filter\AbstractFilter
Inherited

inherited_from \Zend\Ldap\Filter\AbstractFilter::negate()

Returns

Returns a string representation of the filter.

toString() : string

Returns

string

Undoes the conversion done by {@link escapeValue()}.

unescapeValue(string | array $values) : array
Inherited

Converts any sequences of a backslash followed by two hex digits into the corresponding character.

see \Zend\Ldap\Filter\Net_LDAP2_Util::escape_filter_value()
link http://pear.php.net/package/Net_LDAP2
author Benedikt Hallinger
inherited_from \Zend\Ldap\Filter\AbstractFilter::unescapeValue()

Parameters

$values

stringarray

Array of values to escape

Returns

arrayArray $values, but unescaped

 Properties

 

The filter.

$filter : string