PHP Класс LdapTools\BatchModify\BatchCollection

Автор: Chad Sikorra ([email protected])
Наследование: implements IteratorAggregate
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$batches Batch[]
$dn The distinguished name of the LDAP object these batches will target.

Открытые методы

Метод Описание
__clone ( ) When a batch collection is cloned, we want to make sure the batch objects are cloned as well.
__construct ( string | null $dn = null )
add ( Batch $batch ) Add an individual batch action to the collection.
get ( integer $index ) : Batch Get a specific batch from the collection by its index number in the array.
getBatchArray ( ) : array Get an array that represents the array form of each batch action to be sent to LDAP.
getDn ( ) : string Get the distinguished name of the LDAP object this batch will target.
getIterator ( ) : ArrayIterator Allows this object to be iterated over.
has ( integer $index ) : boolean Check if a specific batch index exists.
remove ( integer $index ) : Batch Remove a specific batch from the collection by its index number in the array.
setDn ( string $dn ) Set the distinguished name of the LDAP object this batch will target.
toArray ( ) : Batch[] Get an array containing all the batch action objects.

Защищенные методы

Метод Описание
validateBatchIndexExists ( integer $index ) Checks to make sure that the index actually exists.

Описание методов

__clone() публичный метод

When a batch collection is cloned, we want to make sure the batch objects are cloned as well.
public __clone ( )

__construct() публичный метод

public __construct ( string | null $dn = null )
$dn string | null

add() публичный метод

Add an individual batch action to the collection.
public add ( Batch $batch )
$batch Batch

get() публичный метод

Get a specific batch from the collection by its index number in the array.
public get ( integer $index ) : Batch
$index integer
Результат Batch

getBatchArray() публичный метод

Get an array that represents the array form of each batch action to be sent to LDAP.
public getBatchArray ( ) : array
Результат array

getDn() публичный метод

Get the distinguished name of the LDAP object this batch will target.
public getDn ( ) : string
Результат string

getIterator() публичный метод

Allows this object to be iterated over.
public getIterator ( ) : ArrayIterator
Результат ArrayIterator

has() публичный метод

Check if a specific batch index exists.
public has ( integer $index ) : boolean
$index integer
Результат boolean

remove() публичный метод

Remove a specific batch from the collection by its index number in the array.
public remove ( integer $index ) : Batch
$index integer
Результат Batch

setDn() публичный метод

Set the distinguished name of the LDAP object this batch will target.
public setDn ( string $dn )
$dn string

toArray() публичный метод

Get an array containing all the batch action objects.
public toArray ( ) : Batch[]
Результат Batch[]

validateBatchIndexExists() защищенный метод

Checks to make sure that the index actually exists.
protected validateBatchIndexExists ( integer $index )
$index integer

Описание свойств

$batches защищенное свойство

protected Batch[],LdapTools\BatchModify $batches
Результат Batch[]

$dn защищенное свойство

The distinguished name of the LDAP object these batches will target.
protected $dn