PHP 클래스 LdapTools\Connection\PageControl

저자: Chad Sikorra ([email protected])
파일 보기 프로젝트 열기: ldaptools/ldaptools

보호된 프로퍼티들

프로퍼티 타입 설명
$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