Ldap/Collection.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Ldap
- Version
- $Id$
\Zend_Ldap_Collection
Package: Zend_Ldap
Zend_Ldap_Collection wraps a list of LDAP entries.
- Implements
- Children
- \Zend_Ldap_Node_Collection
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_cache = array()Container for item caching to speed up multiple iterations
Default value
array()Details- Type
- array
integer $_current = -1Current item number
Default value
-1Details- Type
- integer
\Zend_Ldap_Collection_Iterator_Default $_iterator = nullIterator
Default value
nullDetailsMethods
__construct(\Zend_Ldap_Collection_Iterator_Default $iterator) : voidConstructor.
Parameters
| Name | Type | Description |
|---|---|---|
| $iterator | \Zend_Ldap_Collection_Iterator_Default |
__destruct() : void_createEntry(array $data) : arrayCreates the data structure for the given entry data
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| array |
close() : booleanCloses the current result set
Returns
| Type | Description |
|---|---|
| boolean |
count() : intReturns the number of items in current result Implements Countable
Returns
| Type | Description |
|---|---|
| int |
current() : array | nullReturn the current result item Implements Iterator
Returns
Throws
| Type | Description |
|---|---|
| array | null |
| Exception | Description |
|---|---|
| \Zend_Ldap_Exception |
dn() : string | nullReturn the current result item DN
Returns
| Type | Description |
|---|---|
| string | null |
getFirst() : arrayGet first entry
Returns
| Type | Description |
|---|---|
| array |
getInnerIterator() : \Zend_Ldap_Collection_Iterator_DefaultReturns the underlying iterator
Returns
| Type | Description |
|---|---|
| \Zend_Ldap_Collection_Iterator_Default |
key() : int | nullReturn the current result item key Implements Iterator
Returns
| Type | Description |
|---|---|
| int | null |
next() : voidMove forward to next result item Implements Iterator
Throws
| Exception | Description |
|---|---|
| \Zend_Ldap_Exception |
rewind() : voidRewind the Iterator to the first result item Implements Iterator
Throws
| Exception | Description |
|---|---|
| \Zend_Ldap_Exception |
toArray() : arrayGet all entries as an array
Returns
| Type | Description |
|---|---|
| array |
valid() : booleanCheck if there is a current result item after calls to rewind() or next() Implements Iterator
Returns
| Type | Description |
|---|---|
| boolean |