PHP 클래스 Adldap\Objects\Paginator

상속: implements Countabl\Countable, implements IteratorAggregat\IteratorAggregate

보호된 프로퍼티들

프로퍼티	타입	설명
$currentOffset	integer	The current entry offset number.
$currentPage	integer	The current page number.
$pages	integer	The total amount of pages.
$perPage	integer	The amount of entries per page.
$results	array	The complete results array.

공개 메소드들

메소드	설명
__construct ( array $results = [], integer $perPage = 50, integer $currentPage, integer $pages )	Constructor.
count ( ) : integer	Returns the total amount of results.
getCurrentOffset ( ) : integer	Returns the current offset number.
getCurrentPage ( ) : integer	Returns the current page number.
getIterator ( ) : ArrayIterator	Get an iterator for the entries.
getPages ( ) : integer	Returns the total amount of pages in a paginated result.
getPerPage ( ) : integer	Returns the total amount of entries allowed per page.
getResults ( ) : array	Returns the complete results array.

보호된 메소드들

메소드	설명
setCurrentOffset ( integer $offset ) : Paginator	Sets the current offset number.
setCurrentPage ( integer $currentPage ) : Paginator	Sets the current page number.
setPages ( integer $pages ) : Paginator	Sets the total number of pages.
setPerPage ( integer $perPage = 50 ) : Paginator	Sets the number of entries per page.
setResults ( array $results ) : Paginator	Sets the results array property.

메소드 상세

__construct() 공개 메소드

Constructor.

public __construct ( array $results = [], integer $perPage = 50, integer $currentPage, integer $pages )
$results	array
$perPage	integer
$currentPage	integer
$pages	integer

count() 공개 메소드

Returns the total amount of results.

public count ( ) : integer
리턴	integer

getCurrentOffset() 공개 메소드

Returns the current offset number.

public getCurrentOffset ( ) : integer
리턴	integer

getCurrentPage() 공개 메소드

Returns the current page number.

public getCurrentPage ( ) : integer
리턴	integer

getIterator() 공개 메소드

Get an iterator for the entries.

public getIterator ( ) : ArrayIterator
리턴	ArrayIterator

getPages() 공개 메소드

Returns the total amount of pages in a paginated result.

public getPages ( ) : integer
리턴	integer

getPerPage() 공개 메소드

Returns the total amount of entries allowed per page.

public getPerPage ( ) : integer
리턴	integer

getResults() 공개 메소드

Returns the complete results array.

public getResults ( ) : array
리턴	array

setCurrentOffset() 보호된 메소드

Sets the current offset number.

protected setCurrentOffset ( integer $offset ) : Paginator
$offset	integer
리턴	Paginator

setCurrentPage() 보호된 메소드

Sets the current page number.

protected setCurrentPage ( integer $currentPage ) : Paginator
$currentPage	integer
리턴	Paginator

setPages() 보호된 메소드

Sets the total number of pages.

protected setPages ( integer $pages ) : Paginator
$pages	integer
리턴	Paginator

setPerPage() 보호된 메소드

Sets the number of entries per page.

protected setPerPage ( integer $perPage = 50 ) : Paginator
$perPage	integer
리턴	Paginator

setResults() 보호된 메소드

Sets the results array property.

protected setResults ( array $results ) : Paginator
$results	array
리턴	Paginator

프로퍼티 상세

$currentOffset 보호되어 있는 프로퍼티

The current entry offset number.

protected int $currentOffset
리턴	integer

$currentPage 보호되어 있는 프로퍼티

The current page number.

protected int $currentPage
리턴	integer

$pages 보호되어 있는 프로퍼티

The total amount of pages.

protected int $pages
리턴	integer

$perPage 보호되어 있는 프로퍼티

The amount of entries per page.

protected int $perPage
리턴	integer

$results 보호되어 있는 프로퍼티

The complete results array.

protected array $results
리턴	array