Ldap/Collection.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: Collection.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Ldap_Collection
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
- 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
- Properties
- $_iterator
- $_current
- $_cache
- Methods
- __construct
- __destruct
- close
- toArray
- getFirst
- getInnerIterator
- count
- current
- _createEntry
- dn
- key
- next
- rewind
- valid
Description
Zend_Ldap_Collection wraps a list of LDAP entries.
Properties
$_cache
array $_cache = 'array'Container for item caching to speed up multiple iterations
Details
- $_cache
- array
- visibility
- protected
- default
- array
- final
- false
- static
- false
$_current
integer $_current = '1'Current item number
Details
- $_current
- integer
- visibility
- protected
- default
- 1
- final
- false
- static
- false
$_iterator
Zend_Ldap_Collection_Iterator_Default $_iterator = 'null'Iterator
Details
- $_iterator
-
Zend_Ldap_Collection_Iterator_Default
- visibility
- protected
- default
- null
- final
- false
- static
- false
Methods
__construct
__construct(
Zend_Ldap_Collection_Iterator_Default $iterator
)
:
Constructor.
Arguments
- $iterator
- Zend_Ldap_Collection_Iterator_Default
Details
- visibility
- public
- final
- false
- static
- false
__destruct
__destruct(
)
:
Details
- visibility
- public
- final
- false
- static
- false
_createEntry
_createEntry(
array $data
)
:
arrayCreates the data structure for the given entry data
Arguments
- $data
- array
Output
- array
Details
- visibility
- protected
- final
- false
- static
- false
close
close(
)
:
booleanCloses the current result set
Output
- boolean
Details
- visibility
- public
- final
- false
- static
- false
count
count(
)
:
intReturns the number of items in current result Implements Countable
Output
- int
Details
- visibility
- public
- final
- false
- static
- false
current
current(
)
:
array|nullReturn the current result item Implements Iterator
Output
- array|null
Details
- visibility
- public
- final
- false
- static
- false
- throws
dn
dn(
)
:
string|nullReturn the current result item DN
Output
- string|null
Details
- visibility
- public
- final
- false
- static
- false
getFirst
getFirst(
)
:
arrayGet first entry
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
getInnerIterator
getInnerIterator(
)
:
Zend_Ldap_Collection_Iterator_DefaultReturns the underlying iterator
Details
- visibility
- public
- final
- false
- static
- false
key
key(
)
:
int|nullReturn the current result item key Implements Iterator
Output
- int|null
Details
- visibility
- public
- final
- false
- static
- false
next
next(
)
:
Move forward to next result item Implements Iterator
Details
- visibility
- public
- final
- false
- static
- false
- throws
rewind
rewind(
)
:
Rewind the Iterator to the first result item Implements Iterator
Details
- visibility
- public
- final
- false
- static
- false
- throws
toArray
toArray(
)
:
arrayGet all entries as an array
Output
- array
Details
- visibility
- public
- final
- false
- static
- false
valid
valid(
)
:
booleanCheck if there is a current result item after calls to rewind() or next() Implements Iterator
Output
- boolean
Details
- visibility
- public
- final
- false
- static
- false