Ldap/Filter.php

Show:

inherited

Classes
- \Zend_Ldap_Filter

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 [email protected] 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
jump to top

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

 
                TYPE_EQUALS
                = '='

 
                TYPE_GREATER
                = '>'

 
                TYPE_GREATEROREQUAL
                = '>='

 
                TYPE_LESS
                = '<'

 
                TYPE_LESSOREQUAL
                = '<='

 
                TYPE_APPROX
                = '~='

Properties

string $_filter =

inherited

The filter.

Inherited from: \Zend_Ldap_Filter_String::$$_filter

Details

Type: string
Inherited_from: \Zend_Ldap_Filter_String::$$_filter

Methods

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

Creates a new Zend_Ldap_Filter.

Parameters

Name	Type	Description
$attr	string
$value	string
$filtertype	string
$prepend	string
$append	string

__toString() : string

inherited

Returns a string representation of the filter.

Inherited from: \Zend_Ldap_Filter_Abstract::__toString()\Zend_Ldap_Filter_String::__toString()

Returns

Type	Description
string

Details

See: \global\toString()

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

static

Create a filter string.

Parameters

Name	Type	Description
$attr	string
$value	string
$filtertype	string
$prepend	string
$append	string

Returns

Type	Description
string

addAnd( $filter) : \Zend_Ldap_Filter_And

inherited

Creates an 'and' filter.

Inherited from: \Zend_Ldap_Filter_Abstract::addAnd()\Zend_Ldap_Filter_String::addAnd()

Parameters

Name	Type	Description
$filter

Returns

Type	Description
\Zend_Ldap_Filter_And

addOr( $filter) : \Zend_Ldap_Filter_Or

inherited

Creates an 'or' filter.

Inherited from: \Zend_Ldap_Filter_Abstract::addOr()\Zend_Ldap_Filter_String::addOr()

Parameters

Name	Type	Description
$filter

Returns

Type	Description
\Zend_Ldap_Filter_Or

andFilter( $filter) : \Zend_Ldap_Filter_And

static

Creates an 'and' filter.

Parameters

Name	Type	Description
$filter

Returns

Type	Description
\Zend_Ldap_Filter_And

any(string $attr) : \Zend_Ldap_Filter

static

Creates an 'any' filter.

(attr=*)

Parameters

Name	Type	Description
$attr	string

Returns

Type	Description
\Zend_Ldap_Filter

approx(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates an 'approx' filter.

(attr~=value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

begins(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates a 'begins with' filter.

(attr=value*)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

contains(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates a 'contains' filter.

(attr=value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

ends(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates an 'ends with' filter.

(attr=*value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

equals(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates an 'equals' filter.

(attr=value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

escapeValue(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

Name	Type	Description
$values	string \| array	Array of values to escape

Returns

Type	Description
array	Array $values, but escaped

Details

Author: Benedikt Hallinger
Link: http://pear.php.net/package/Net_LDAP2
See: \global\Net_LDAP2_Util::escape_filter_value()

greater(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates a 'greater' filter.

(attr>value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

greaterOrEqual(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates a 'greater or equal' filter.

(attr>=value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

less(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates a 'less' filter.

(attr<value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

lessOrEqual(string $attr, string $value) : \Zend_Ldap_Filter

static

Creates an 'less or equal' filter.

(attr<=value)

Parameters

Name	Type	Description
$attr	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter

mask(string $mask, string $value) : \Zend_Ldap_Filter_Mask

static

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

Parameters

Name	Type	Description
$mask	string
$value	string

Returns

Type	Description
\Zend_Ldap_Filter_Mask

negate() : \Zend_Ldap_Filter_Abstract

inherited

Negates the filter.

Inherited from: \Zend_Ldap_Filter_Abstract::negate()\Zend_Ldap_Filter_String::negate()

Returns

Type	Description
\Zend_Ldap_Filter_Abstract

orFilter( $filter) : \Zend_Ldap_Filter_Or

static

Creates an 'or' filter.

Parameters

Name	Type	Description
$filter

Returns

Type	Description
\Zend_Ldap_Filter_Or

string(string $filter) : \Zend_Ldap_Filter_String

static

Creates a simple custom string filter.

Parameters

Name	Type	Description
$filter	string

Returns

Type	Description
\Zend_Ldap_Filter_String

toString() : string

inherited

Returns a string representation of the filter.

Inherited from: \Zend_Ldap_Filter_String::toString()

Returns

Type	Description
string

unescapeValue(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

Name	Type	Description
$values	string \| array	Array of values to escape

Returns

Type	Description
array	Array $values, but unescaped

Details

Author: Benedikt Hallinger
Link: http://pear.php.net/package/Net_LDAP2
See: \global\Net_LDAP2_Util::escape_filter_value()

Ldap/Filter.php

\Zend_Ldap_Filterjump to top

Constants

Properties

Methods

\Zend_Ldap_Filter
jump to top