API Documentation

Zend/Ldap/Filter/Abstract.php

Show: inherited
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: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Ldap_Filter_Abstract

Package: Zend\Ldap\Filter

Zend_Ldap_Filter_Abstract provides a base implementation for filters.

Children
\Zend_Ldap_Filter_String
\Zend_Ldap_Filter_Logical
\Zend_Ldap_Filter_Not
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpublic__toString( ) : string

Returns a string representation of the filter.

Returns
Type Description
string
Details
See
\toString()  
methodpublicaddAnd(  $filter ) : \Zend_Ldap_Filter_And

Creates an 'and' filter.

Parameters
Name Type Description
$filter
Returns
Type Description
\Zend_Ldap_Filter_And
methodpublicaddOr(  $filter ) : \Zend_Ldap_Filter_Or

Creates an 'or' filter.

Parameters
Name Type Description
$filter
Returns
Type Description
\Zend_Ldap_Filter_Or
methodpublicescapeValue( string|array $values = array() ) : array
static

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.

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
\Net_LDAP2_Util::escape_filter_value()  
methodpublicnegate( ) : \Zend_Ldap_Filter_Abstract

Negates the filter.

Returns
Type Description
\Zend_Ldap_Filter_Abstract
methodpublictoString( ) : string
abstract

Returns a string representation of the filter.

Returns
Type Description
string
methodpublicunescapeValue( string|array $values = array() ) : array
static

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

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
\Net_LDAP2_Util::escape_filter_value()  
Documentation was generated by DocBlox 0.15.1.