Ldap/Filter.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

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

Package: Zend\Ldap\Filter
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

>VConstant  TYPE_EQUALS = '='
>VConstant  TYPE_GREATER = '>'
>VConstant  TYPE_GREATEROREQUAL = '>='
>VConstant  TYPE_LESS = '<'
>VConstant  TYPE_LESSOREQUAL = '<='
>VConstant  TYPE_APPROX = '~='

Properties

>VPropertyprotectedstring $_filter
inherited
The filter.
Inherited from: \Zend_Ldap_Filter_String::$$_filter
Details
Type
string
Inherited_from
\Zend_Ldap_Filter_String::$$_filter  

Methods

methodpublic__construct(string $attr, string $value, string $filtertype, string $prepend = null, string $append = null) : void

Creates a new Zend_Ldap_Filter.

Parameters
NameTypeDescription
$attrstring
$valuestring
$filtertypestring
$prependstring
$appendstring
methodpublic__toString() : string
inherited

Returns a string representation of the filter.

Inherited from: \Zend_Ldap_Filter_Abstract::__toString()\Zend_Ldap_Filter_String::__toString()
Returns
TypeDescription
string
Details
See
\toString()  
methodprivate_createFilterString(string $attr, string $value, string $filtertype, string $prepend = null, string $append = null) : string
static

Create a filter string.

Parameters
NameTypeDescription
$attrstring
$valuestring
$filtertypestring
$prependstring
$appendstring
Returns
TypeDescription
string
methodpublicaddAnd( $filter) : \Zend_Ldap_Filter_And
inherited

Creates an 'and' filter.

Inherited from: \Zend_Ldap_Filter_Abstract::addAnd()\Zend_Ldap_Filter_String::addAnd()
Parameters
NameTypeDescription
$filter
Returns
TypeDescription
\Zend_Ldap_Filter_And
methodpublicaddOr( $filter) : \Zend_Ldap_Filter_Or
inherited

Creates an 'or' filter.

Inherited from: \Zend_Ldap_Filter_Abstract::addOr()\Zend_Ldap_Filter_String::addOr()
Parameters
NameTypeDescription
$filter
Returns
TypeDescription
\Zend_Ldap_Filter_Or
methodpublicandFilter( $filter) : \Zend_Ldap_Filter_And
static

Creates an 'and' filter.

Parameters
NameTypeDescription
$filter
Returns
TypeDescription
\Zend_Ldap_Filter_And
methodpublicany(string $attr) : \Zend_Ldap_Filter
static

Creates an 'any' filter.

(attr=*)

Parameters
NameTypeDescription
$attrstring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicapprox(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates an 'approx' filter.

(attr~=value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicbegins(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates a 'begins with' filter.

(attr=value*)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpubliccontains(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates a 'contains' filter.

(attr=value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicends(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates an 'ends with' filter.

(attr=*value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicequals(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates an 'equals' filter.

(attr=value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicescapeValue(string | array $values = array()) : array
staticinherited

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.

Parameters
NameTypeDescription
$valuesstring | array

Array of values to escape

Returns
TypeDescription
arrayArray $values, but escaped
Details
Author
Benedikt Hallinger  
Link
http://pear.php.net/package/Net_LDAP2  
See
from Benedikt Hallinger  
methodpublicgreater(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates a 'greater' filter.

(attr>value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicgreaterOrEqual(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates a 'greater or equal' filter.

(attr>=value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicless(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates a 'less' filter.

(attr<value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpubliclessOrEqual(string $attr, string $value) : \Zend_Ldap_Filter
static

Creates an 'less or equal' filter.

(attr<=value)

Parameters
NameTypeDescription
$attrstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter
methodpublicmask(string $mask, string $value) : \Zend_Ldap_Filter_Mask
static

Creates a simple string filter to be used with a mask.

Parameters
NameTypeDescription
$maskstring
$valuestring
Returns
TypeDescription
\Zend_Ldap_Filter_Mask
methodpublicorFilter( $filter) : \Zend_Ldap_Filter_Or
static

Creates an 'or' filter.

Parameters
NameTypeDescription
$filter
Returns
TypeDescription
\Zend_Ldap_Filter_Or
methodpublicstring(string $filter) : \Zend_Ldap_Filter_String
static

Creates a simple custom string filter.

Parameters
NameTypeDescription
$filterstring
Returns
TypeDescription
\Zend_Ldap_Filter_String
methodpublictoString() : string
inherited

Returns a string representation of the filter.

Inherited from: \Zend_Ldap_Filter_String::toString()
Returns
TypeDescription
string
methodpublicunescapeValue(string | array $values = array()) : array
staticinherited

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.

Parameters
NameTypeDescription
$valuesstring | array

Array of values to escape

Returns
TypeDescription
arrayArray $values, but unescaped
Details
Author
Benedikt Hallinger  
Link
http://pear.php.net/package/Net_LDAP2  
See
from Benedikt Hallinger  
Documentation was generated by phpDocumentor 2.0.0a12.