Collection
in package
implements
Iterator, Countable
Laminas\Ldap\Collection wraps a list of LDAP entries.
Tags
Table of Contents
Interfaces
- Iterator
- Countable
Properties
- $cache : array<int, TItem>
- Container for item caching to speed up multiple iterations
- $current : int
- Current item number
- $iterator : DefaultIterator
- Iterator
Methods
- __construct() : mixed
- __destruct() : mixed
- close() : bool
- Closes the current result set
- count() : mixed
- current() : mixed
- dn() : string|null
- Return the current result item DN
- getFirst() : TItem|null
- Get first entry
- getInnerIterator() : DefaultIterator
- Returns the underlying iterator
- key() : mixed
- next() : mixed
- rewind() : mixed
- toArray() : array<int, TItem>
- Get all entries as an array
- valid() : mixed
- createEntry() : TItem
- Creates the data structure for the given entry data
Properties
$cache
Container for item caching to speed up multiple iterations
protected
array<int, TItem>
$cache
= []
$current
Current item number
protected
int
$current
= -1
$iterator
Iterator
protected
DefaultIterator
$iterator
Methods
__construct()
public
__construct(DefaultIterator $iterator) : mixed
Parameters
- $iterator : DefaultIterator
__destruct()
public
__destruct() : mixed
close()
Closes the current result set
public
close() : bool
Return values
boolcount()
public
count() : mixed
Tags
Attributes
current()
public
current() : mixed
Tags
Attributes
dn()
Return the current result item DN
public
dn() : string|null
Return values
string|nullgetFirst()
Get first entry
public
getFirst() : TItem|null
Return values
TItem|nullgetInnerIterator()
Returns the underlying iterator
public
getInnerIterator() : DefaultIterator
Return values
DefaultIteratorkey()
public
key() : mixed
Tags
Attributes
next()
public
next() : mixed
Tags
Attributes
rewind()
public
rewind() : mixed
Tags
Attributes
toArray()
Get all entries as an array
public
toArray() : array<int, TItem>
Return values
array<int, TItem>valid()
public
valid() : mixed
Tags
Attributes
createEntry()
Creates the data structure for the given entry data
protected
createEntry(array<string|int, mixed> $data) : TItem
Parameters
- $data : array<string|int, mixed>