API Documentation

Ldap/Filter.php

Includes 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: Filter.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Ldap_Filter

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

Extends from
Zend_Ldap_Filter_String
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
Constants
TYPE_EQUALS
TYPE_GREATER
TYPE_GREATEROREQUAL
TYPE_LESS
TYPE_LESSOREQUAL
TYPE_APPROX
Methods
equals
begins
ends
contains
greater
greaterOrEqual
less
lessOrEqual
approx
any
string
mask
andFilter
orFilter
_createFilterString
__construct

Description

Zend_Ldap_Filter.

Constants

TYPE_EQUALS

 TYPE_EQUALS = '='

Details

value
=

TYPE_GREATER

 TYPE_GREATER = '>'

Details

value
>

TYPE_GREATEROREQUAL

 TYPE_GREATEROREQUAL = '>='

Details

value
>=

TYPE_LESS

 TYPE_LESS = '<'

Details

value
<

TYPE_LESSOREQUAL

 TYPE_LESSOREQUAL = '<='

Details

value
<=

TYPE_APPROX

 TYPE_APPROX = '~='

Details

value
~=

Methods

__construct

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

Creates a new Zend_Ldap_Filter.

Arguments
$attr
string
$value
string
$filtertype
string
$prepend
string
$append
string
Details
visibility
public
final
false
static
false

_createFilterString

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

Create a filter string.

Arguments
$attr
string
$value
string
$filtertype
string
$prepend
string
$append
string
Output
string
Details
visibility
private
final
false
static
true

andFilter

andFilter(  $filter ) : Zend_Ldap_Filter_And

Creates an 'and' filter.

Arguments
$filter
Details
visibility
public
final
false
static
true

any

any( string $attr ) : Zend_Ldap_Filter

Creates an 'any' filter.

(attr=*)

Arguments
$attr
string
Details
visibility
public
final
false
static
true

approx

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

Creates an 'approx' filter.

(attr~=value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

begins

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

Creates a 'begins with' filter.

(attr=value*)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

contains

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

Creates a 'contains' filter.

(attr=value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

ends

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

Creates an 'ends with' filter.

(attr=*value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

equals

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

Creates an 'equals' filter.

(attr=value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

greater

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

Creates a 'greater' filter.

(attr>value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

greaterOrEqual

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

Creates a 'greater or equal' filter.

(attr>=value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

less

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

Creates a 'less' filter.

(attr<value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

lessOrEqual

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

Creates an 'less or equal' filter.

(attr<=value)

Arguments
$attr
string
$value
string
Details
visibility
public
final
false
static
true

mask

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

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

Arguments
$mask
string
$value
string
Details
visibility
public
final
false
static
true

orFilter

orFilter(  $filter ) : Zend_Ldap_Filter_Or

Creates an 'or' filter.

Arguments
$filter
Details
visibility
public
final
false
static
true

string

string( string $filter ) : Zend_Ldap_Filter_String

Creates a simple custom string filter.

Arguments
$filter
string
Details
visibility
public
final
false
static
true
Documentation was generated by DocBlox.