Ldap/Filter.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Ldap
- Subpackage
- Filter
- Version
- $Id: Filter.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Ldap_Filter
- Parent(s)
- \Zend_Ldap_Filter_String < \Zend_Ldap_Filter_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties
Methods


__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()\Zend_Ldap_Filter_String::__toString()Type | Description |
---|---|
string |
- See
- \toString()


_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()\Zend_Ldap_Filter_String::addAnd()Name | Type | Description |
---|---|---|
$filter |
Type | Description |
---|---|
\Zend_Ldap_Filter_And |


addOr( $filter) : \Zend_Ldap_Filter_Or
Creates an 'or' filter.
Inherited from: \Zend_Ldap_Filter_Abstract::addOr()\Zend_Ldap_Filter_String::addOr()Name | Type | Description |
---|---|---|
$filter |
Type | Description |
---|---|
\Zend_Ldap_Filter_Or |


andFilter( $filter) : \Zend_Ldap_Filter_And
Creates an 'and' filter.
Name | Type | Description |
---|---|---|
$filter |
Type | Description |
---|---|
\Zend_Ldap_Filter_And |


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()\Zend_Ldap_Filter_String::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 |
- Author
- Benedikt Hallinger
- Link
- http://pear.php.net/package/Net_LDAP2
- See
- from Benedikt Hallinger


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()\Zend_Ldap_Filter_String::negate()Type | Description |
---|---|
\Zend_Ldap_Filter_Abstract |


orFilter( $filter) : \Zend_Ldap_Filter_Or
Creates an 'or' filter.
Name | Type | Description |
---|---|---|
$filter |
Type | Description |
---|---|
\Zend_Ldap_Filter_Or |


string(string $filter) : \Zend_Ldap_Filter_String
Creates a simple custom string filter.
Name | Type | Description |
---|---|---|
$filter | string |
Type | Description |
---|---|
\Zend_Ldap_Filter_String |


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()\Zend_Ldap_Filter_String::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 |
- Author
- Benedikt Hallinger
- Link
- http://pear.php.net/package/Net_LDAP2
- See
- from Benedikt Hallinger