Ldap/Collection/Iterator/Default.php

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
version: $Id: Default.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Ldap_Collection_Iterator_Default

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_Collection_Iterator_Default
jump to top

Implements
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
Constants: ATTRIBUTE_TO_LOWER; ATTRIBUTE_TO_UPPER; ATTRIBUTE_NATIVE
Properties: $_ldap; $_resultId; $_current; $_itemCount; $_attributeNameTreatment
Methods: __construct; __destruct; close; getLdap; setAttributeNameTreatment; getAttributeNameTreatment; count; current; key; next; rewind; valid

Description

Zend_Ldap_Collection_Iterator_Default is the default collection iterator implementation using ext/ldap

Constants

ATTRIBUTE_TO_LOWER
jump to class

 ATTRIBUTE_TO_LOWER = '1'

Details

value: 1

ATTRIBUTE_TO_UPPER
jump to class

 ATTRIBUTE_TO_UPPER = '2'

Details

value: 2

ATTRIBUTE_NATIVE
jump to class

 ATTRIBUTE_NATIVE = '3'

Details

value: 3

Properties

$_attributeNameTreatment
jump to class

integer|callback $_attributeNameTreatment = 'self'

The method that will be applied to the attribute's names.

Details

$_attributeNameTreatment: integer|callback
visibility: protected
default: self
final: false
static: false

$_current
jump to class

resource $_current = 'null'

Current result entry identifier

Details

$_current: resource
visibility: protected
default: null
final: false
static: false

$_itemCount
jump to class

integer $_itemCount = '1'

Number of items in query result

Details

$_itemCount: integer
visibility: protected
default: 1
final: false
static: false

$_ldap
jump to class

Zend_Ldap $_ldap = 'null'

LDAP Connection

Details

$_ldap: Zend_Ldap
visibility: protected
default: null
final: false
static: false

$_resultId
jump to class

resource $_resultId = 'null'

Result identifier resource

Details

$_resultId: resource
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          Zend_Ldap $ldap, resource $resultId
          )
        
        :
        void

Constructor.

Arguments

$ldap: Zend_Ldap
$resultId: resource

Details

visibility: public
final: false
static: false

__destruct
jump to class

__destruct(
          
          )
        
        :

Details

visibility: public
final: false
static: false

close
jump to class

Closes the current result set

Output

bool

Details

visibility: public
final: false
static: false

count
jump to class

Returns the number of items in current result Implements Countable

Output

int

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        array|null

Return the current result item Implements Iterator

Output

array|null

Details

visibility: public
final: false
static: false
throws

getAttributeNameTreatment
jump to class

getAttributeNameTreatment(
          
          )
        
        :
        integer|callback

Returns the currently set attribute name treatment

Output

integer|callback

Details

visibility: public
final: false
static: false

getLdap
jump to class

getLdap(
          
          )
        
        :
        Zend_Ldap

Gets the current LDAP connection.

Output

Zend_Ldap

Details

visibility: public
final: false
static: false

key
jump to class

key(
          
          )
        
        :
        string|null

Return the result item key Implements Iterator

Output

string|null

Details

visibility: public
final: false
static: false

next
jump to class

Move forward to next result item Implements Iterator

Details

visibility: public
final: false
static: false
throws

rewind
jump to class

Rewind the Iterator to the first result item Implements Iterator

Details

visibility: public
final: false
static: false
throws

setAttributeNameTreatment
jump to class

setAttributeNameTreatment(
          integer|callback $attributeNameTreatment
          )
        
        :
        Zend_Ldap_Collection_Iterator_Default

Sets the attribute name treatment.

Can either be one of the following constants - Zend_Ldap_Collection_Iterator_Default::ATTRIBUTE_TO_LOWER - Zend_Ldap_Collection_Iterator_Default::ATTRIBUTE_TO_UPPER - Zend_Ldap_Collection_Iterator_Default::ATTRIBUTE_NATIVE or a valid callback accepting the attribute's name as it's only argument and returning the new attribute's name.

Arguments

$attributeNameTreatment: integercallback

Output

Zend_Ldap_Collection_Iterator_Default: Provides a fluent interface

Details

visibility: public
final: false
static: false

valid
jump to class

valid(
          
          )
        
        :
        boolean

Check if there is a current result item after calls to rewind() or next() Implements Iterator

Output

boolean

Details

visibility: public
final: false
static: false

API Documentation

Ldap/Collection/Iterator/Default.php

Description

Zend_Ldap_Collection_Iterator_Defaultjump to top

Description

Constants

ATTRIBUTE_TO_LOWERjump to class

Details

ATTRIBUTE_TO_UPPERjump to class

Details

ATTRIBUTE_NATIVEjump to class

Details

Properties

$_attributeNameTreatmentjump to class

Details

$_currentjump to class

Details

$_itemCountjump to class

Details

$_ldapjump to class

Details

$_resultIdjump to class

Details

Methods

__constructjump to class

Arguments

Details

__destructjump to class

Details

closejump to class

Output

Details

countjump to class

Output

Details

currentjump to class

Output

Details

getAttributeNameTreatmentjump to class

Output

Details

getLdapjump to class

Output

Details

keyjump to class

Output

Details

nextjump to class

Details

rewindjump to class

Details

setAttributeNameTreatmentjump to class

Arguments

Output

Details

validjump to class

Output

Details

Zend_Ldap_Collection_Iterator_Default
jump to top

ATTRIBUTE_TO_LOWER
jump to class

ATTRIBUTE_TO_UPPER
jump to class

ATTRIBUTE_NATIVE
jump to class

$_attributeNameTreatment
jump to class

$_current
jump to class

$_itemCount
jump to class

$_ldap
jump to class

$_resultId
jump to class

__construct
jump to class

__destruct
jump to class

close
jump to class

count
jump to class

current
jump to class

getAttributeNameTreatment
jump to class

getLdap
jump to class

key
jump to class

next
jump to class

rewind
jump to class

setAttributeNameTreatment
jump to class

valid
jump to class