API Documentation

Ldap/Filter/Abstract.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Ldap
subpackage
Filter
version
$Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Ldap_Filter_Abstract

Description

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_Abstract

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Ldap
subpackage
Filter
Methods
toString
__toString
negate
addAnd
addOr
escapeValue
unescapeValue

Description

Zend_Ldap_Filter_Abstract provides a base implementation for filters.

Methods

__toString

__toString( ) : string

Returns a string representation of the filter.

Output
string
Details
visibility
public
final
false
static
false
see
toString()

addAnd

addAnd(  $filter ) : Zend_Ldap_Filter_And

Creates an 'and' filter.

Arguments
$filter
Details
visibility
public
final
false
static
false

addOr

addOr(  $filter ) : Zend_Ldap_Filter_Or

Creates an 'or' filter.

Arguments
$filter
Details
visibility
public
final
false
static
false

escapeValue

escapeValue( string|array $values = array ) : array

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

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.

Arguments
$values
stringarray
Array of values to escape
Output
array
Array $values, but escaped
Details
visibility
public
final
false
static
true
author
Benedikt Hallinger <beni@php.net>
link
http://pear.php.net/package/Net_LDAP2
see
Net_LDAP2_Util::escape_filter_value() from Benedikt Hallinger <beni@php.net>

negate

negate( ) : Zend_Ldap_Filter_Abstract

Negates the filter.

Details
visibility
public
final
false
static
false

toString

toString( ) : string

Returns a string representation of the filter.

Output
string
Details
visibility
public
final
false
static
false

unescapeValue

unescapeValue( string|array $values = array ) : array

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

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

Arguments
$values
stringarray
Array of values to escape
Output
array
Array $values, but unescaped
Details
visibility
public
final
false
static
true
author
Benedikt Hallinger <beni@php.net>
link
http://pear.php.net/package/Net_LDAP2
see
Net_LDAP2_Util::escape_filter_value() from Benedikt Hallinger <beni@php.net>
Documentation was generated by DocBlox.