AfsPagerHelper Class Reference

Helper for pager. More...

Inheritance diagram for AfsPagerHelper:

Public Member Functions
	__construct ($pager, AfsMetaHelper $meta, AfsQuery $query, AfsHelperConfiguration $config)
	Construct helper with pager and current query.
	get_pages ()
	Retrieves all numbered pages.
	get_current_no ()
	Retrieves current page number.
	has_previous ()
	Checks whether previous page is present in the pager.
	get_previous ()
	Retrieves query for previous page.
	has_next ()
	Checks whether next page is present in the pager.
	get_next ()
	Retrieves query for next page.
	get_last_page ()
	Retrieves last page number along with corresponding query/URL.
	get_last_page_no ()
	Retrieves last page number.
	get_all_pages ()
	Retrieves pages as a simple array with key/value pairs.
	format ()
	Retrieves pages as array.
Public Member Functions inherited from AfsHelperBase
	__get ($name)
	Simple property helper.

Detailed Description

Helper for pager.

This class allows to manage:

• previous page if it exists.
• next page if it exists.
• numbered pages.

Constructor & Destructor Documentation

__construct	(		$pager,
		AfsMetaHelper	$meta,
		AfsQuery	$query,
		AfsHelperConfiguration	$config
	)

Construct helper with pager and current query.

Parameters

$pager	[in] pager retrieved from reply.
$meta	[in] meta data of the replyset.
$query	[in] current AfsQuery which will be used to generate appropriate queries (see bellow get_pages, get_previous and get_next).
$config	[in] helper ocnfiguration object.

Exceptions

InvalidArgumentException

pager is invalid.

Member Function Documentation

format

(

)

Retrieves pages as array.

All data are stored in key => value format:

• pages: list of pages (see AfsPagerHelper::get_pages for details on the format)
• current: current page number.

Query is returned for each page when no query coder has been provided, otherwise query coder is used to produce appropriate URL.

Returns

array filled with key and values.

get_all_pages

(

)

Retrieves pages as a simple array with key/value pairs.

This include previous and next pages if they are present in AFS search engine reply.

All data are stored in key => value format:

• previous: (if present) query or URL to previous page,
• <page number>: query or URL for each page number,
• next: (if present) query or URL to next page,

Returns

get_current_no

(

)

Retrieves current page number.

Returns

Current page number.

get_last_page

(

)

Retrieves last page number along with corresponding query/URL.

When a query coder is available, an URL is returned as second paramter instead of AfsQuery.

Returns

Array with last page available and query/URL.

get_last_page_no

(

)

Retrieves last page number.

Returns

Last page number.

get_next

(

)

Retrieves query for next page.

Returns

query for next page.

Exceptions

OutOfBoundsException

when there is no next page.

get_pages

(

)

Retrieves all numbered pages.

List all pages in ascending order. A query or a URL is associated with each page depending whether no coder or valid one has been provided.

Returns

array of page => query or URL.

get_previous

(

)

Retrieves query for previous page.

Returns

query for previous page.

Exceptions

OutOfBoundsException

when there is no previous page.

has_next

(

)

Checks whether next page is present in the pager.

Returns

True when next page exists, false otherwise.

has_previous

(

)

Checks whether previous page is present in the pager.

Returns

True when previous page exists, false otherwise.