Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Ldap_Filter.

__construct(
string $attr, string $value, string $filtertype, string $prepend
=
null, string $append
=
null
)
:
void
Creates a new Zend_Ldap_Filter.
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string | |
$filtertype | string | |
$prepend | string | |
$append | string |

__toString(
)
:
string
Returns a string representation of the filter.
Inherited from: \Zend_Ldap_Filter_Abstract::__toString()Type | Description |
---|---|
string |

_createFilterString(
string $attr, string $value, string $filtertype, string $prepend
=
null, string $append
=
null
)
:
string
Create a filter string.
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string | |
$filtertype | string | |
$prepend | string | |
$append | string |
Type | Description |
---|---|
string |

addAnd(
$filter
)
:
\Zend_Ldap_Filter_And
Creates an 'and' filter.
Inherited from: \Zend_Ldap_Filter_Abstract::addAnd()
addOr(
$filter
)
:
\Zend_Ldap_Filter_Or
Creates an 'or' filter.
Inherited from: \Zend_Ldap_Filter_Abstract::addOr()
approx(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates an 'approx' filter.
(attr~=value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

begins(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates a 'begins with' filter.
(attr=value*)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

contains(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates a 'contains' filter.
(attr=value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

ends(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates an 'ends with' filter.
(attr=*value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

equals(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates an 'equals' filter.
(attr=value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

escapeValue(
string|array $values
=
array
)
:
array
Escapes the given VALUES according to RFC 2254 so that they can be safely used in LDAP filters.
Inherited from: \Zend_Ldap_Filter_Abstract::escapeValue()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.
Name | Type | Description |
---|---|---|
$values | string|array | Array of values to escape |
Type | Description |
---|---|
array | Array $values, but escaped |

greater(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates a 'greater' filter.
(attr>value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

greaterOrEqual(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates a 'greater or equal' filter.
(attr>=value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

less(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates a 'less' filter.
(attr<value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

lessOrEqual(
string $attr, string $value
)
:
\Zend_Ldap_Filter
Creates an 'less or equal' filter.
(attr<=value)
Name | Type | Description |
---|---|---|
$attr | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter |

mask(
string $mask, string $value
)
:
\Zend_Ldap_Filter_Mask
Creates a simple string filter to be used with a mask.
Name | Type | Description |
---|---|---|
$mask | string | |
$value | string |
Type | Description |
---|---|
\Zend_Ldap_Filter_Mask |

negate(
)
:
\Zend_Ldap_Filter_Abstract
Negates the filter.
Inherited from: \Zend_Ldap_Filter_Abstract::negate()Type | Description |
---|---|
\Zend_Ldap_Filter_Abstract |

toString(
)
:
string
Returns a string representation of the filter.
Inherited from: \Zend_Ldap_Filter_String::toString()Type | Description |
---|---|
string |

unescapeValue(
string|array $values
=
array
)
:
array
Undoes the conversion done by {@link escapeValue()}.
Inherited from: \Zend_Ldap_Filter_Abstract::unescapeValue()Converts any sequences of a backslash followed by two hex digits into the corresponding character.
Name | Type | Description |
---|---|---|
$values | string|array | Array of values to escape |
Type | Description |
---|---|
array | Array $values, but unescaped |