1. class
  2. SilverStripe
  3. \
  4. LDAP
  5. \
  6. Iterators
  7. \
  8. LDAPIterator

LDAPIterator

final class LDAPIterator implements Iterator (View source)

Class LDAPIterator

Methods

public
__construct(Ldap $ldap, string $filter = "", string|null $baseDn = null, array $returnAttributes = null, int $pageSize = 250, bool $resolveRangedAttributes = false)

No description

public
mixed
current()

No description

public
mixed
key()

No description

public
void
next()

No description

public
void
rewind()

No description

public
bool
valid()

No description

Details

at line 55
__construct(Ldap $ldap, string $filter = "", string|null $baseDn = null, array $returnAttributes = null, int $pageSize = 250, bool $resolveRangedAttributes = false)

No description

Parameters

Ldap $ldap

The Laminas\Ldap\Ldap object that this iterator will use to retrieve results from
string $filter

An LDAP search filter (e.g. "(&(objectClass=user)(!(objectClass=computer)))")
string|null $baseDn

The Base DN to search from (or null to search from the connection root)
array $returnAttributes

The attributes to request from the LDAP server, or null to request all
int $pageSize

Number of results per page. This must be less than the LDAP server MaxPageSize setting
bool $resolveRangedAttributes

Whether or not to return ranged attributes

at line 285
mixed current()

No description

Return Value

mixed

at line 297
mixed key()

No description

Return Value

mixed

at line 310
void next()

No description

Return Value

void

at line 322
void rewind()

No description

Return Value

void

at line 333
bool valid()

No description

Return Value

bool