PHP Класс LdapTools\Connection\PageControl

Автор: Chad Sikorra ([email protected])
Показать файл Открыть проект

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

Свойство Тип Описание
$connection LdapTools\Connection\LdapConnectionInterface
$cookie null | string
$isEnabled Whether or not paging is actually active for the connection.
$pageSize The page size for the paging operation.
$resultNumber The result set number the paging operation is currently on.
$sizeLimit The size limit for the paging operation.

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

Метод Описание
__construct ( LdapTools\Connection\LdapConnectionInterface $connection )
end ( ) End a paging operation.
isActive ( ) : boolean Returns whether or not a paging operation is active based on the status of the paging cookie (omnomnom).
isEnabled ( ) : boolean Check whether or not paging is active. If it is not active, the controls methods will not actually do anything.
next ( ) Signifies to the connection to expect the next paged result with the current cookie and page size.
resetPagingControl ( ) Resets the paging control so that read operations work after a paging operation is used.
setIsEnabled ( boolean $enabled ) Set whether or not paging is active and should be used.
start ( integer $pageSize, integer $sizeLimit ) Start a paging operation by setting up the cookie and the page size. Optionally set a size limit.
update ( resource $result ) Updating the paging operation based on the result resource returned from a query.

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

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

public __construct ( LdapTools\Connection\LdapConnectionInterface $connection )
$connection LdapTools\Connection\LdapConnectionInterface

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

End a paging operation.
public end ( )

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

Returns whether or not a paging operation is active based on the status of the paging cookie (omnomnom).
public isActive ( ) : boolean
Результат boolean

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

Check whether or not paging is active. If it is not active, the controls methods will not actually do anything.
public isEnabled ( ) : boolean
Результат boolean

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

Signifies to the connection to expect the next paged result with the current cookie and page size.
public next ( )

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

Resets the paging control so that read operations work after a paging operation is used.
public resetPagingControl ( )

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

Set whether or not paging is active and should be used.
public setIsEnabled ( boolean $enabled )
$enabled boolean

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

Start a paging operation by setting up the cookie and the page size. Optionally set a size limit.
public start ( integer $pageSize, integer $sizeLimit )
$pageSize integer
$sizeLimit integer

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

Updating the paging operation based on the result resource returned from a query.
public update ( resource $result )
$result resource

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

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

protected LdapConnectionInterface,LdapTools\Connection $connection
Результат LdapTools\Connection\LdapConnectionInterface

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

Whether or not paging is actually active for the connection.
protected $isEnabled

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

The page size for the paging operation.
protected $pageSize

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

The result set number the paging operation is currently on.
protected $resultNumber

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

The size limit for the paging operation.
protected $sizeLimit