Galette\Core\Pagination Class Reference

Inheritance diagram for Galette\Core\Pagination:

Collaboration diagram for Galette\Core\Pagination:

Public Member Functions
	__construct ()
	reinit ()
	invertorder ()
	getDirection ()
	setDirection (string $direction)
	setLimits (Select $select)
	setCounter (int $c)
	setViewPagination (RouteParser $routeparser, Twig $view, bool $restricted=true)
	__get (string $name)
	__isset (string $name)
	__set (string $name, mixed $value)

Public Attributes
const	ORDER_ASC = 'ASC'
const	ORDER_DESC = 'DESC'

Protected Member Functions
	getDefaultOrder ()
	getDefaultDirection ()
	countPages ()
	getHref (int $page)

Protected Attributes
Twig	$view
RouteParser	$routeparser
array	$errors = []
array	$pagination_fields

Constructor & Destructor Documentation

__construct()

Galette\Core\Pagination::__construct

(

)

Default constructor

Reimplemented in Galette\Filters\TransactionsList, Galette\Filters\ScheduledPaymentsList, Galette\Filters\MembersList, Galette\Filters\MailingsList, Galette\Filters\HistoryList, and Galette\Filters\ContributionsList.

Member Function Documentation

__get()

Galette\Core\Pagination::__get

(

string

$name

)

Global getter method

Parameters

string

$name

name of the property we want to retrieve

Returns

mixed the called property

Reimplemented in Galette\Filters\TransactionsList, Galette\Filters\ScheduledPaymentsList, Galette\Filters\MembersList, Galette\Filters\HistoryList, Galette\Filters\ContributionsList, and Galette\Filters\AdvancedMembersList.

__isset()

Galette\Core\Pagination::__isset

(

string

$name

)

Global isset method Required for twig to access properties via __get

Parameters

string

$name

name of the property we want to retrieve

Returns

bool

Reimplemented in Galette\Filters\TransactionsList, Galette\Filters\ScheduledPaymentsList, Galette\Filters\MembersList, Galette\Filters\HistoryList, Galette\Filters\ContributionsList, and Galette\Filters\AdvancedMembersList.

__set()

Galette\Core\Pagination::__set	(	string	$name,
		mixed	$value
	)

Global setter method

Parameters

string	$name	name of the property we want to assign a value to
mixed	$value	a relevant value for the property

Returns

void

Reimplemented in Galette\Filters\TransactionsList, Galette\Filters\ScheduledPaymentsList, Galette\Filters\MembersList, Galette\Filters\MailingsList, Galette\Filters\HistoryList, Galette\Filters\ContributionsList, and Galette\Filters\AdvancedMembersList.

countPages()

Galette\Core\Pagination::countPages ( )

protected

Update or set pages count

Returns

void

getDefaultDirection()

Galette\Core\Pagination::getDefaultDirection ( )

protected

Return the default direction for ordering

Returns

string ASC or DESC

Reimplemented in Galette\Filters\SavedSearchesList, Galette\Filters\HistoryList, and Galette\Filters\DocumentsList.

getDefaultOrder()

Galette\Core\Pagination::getDefaultOrder ( )

abstractprotected

Returns the field we want to default set order to

Returns

int|string

Reimplemented in Galette\Filters\TransactionsList, Galette\Filters\ScheduledPaymentsList, Galette\Filters\SavedSearchesList, Galette\Filters\MembersList, Galette\Filters\MailingsList, Galette\Filters\HistoryList, Galette\Filters\DocumentsList, and Galette\Filters\ContributionsList.

getDirection()

Galette\Core\Pagination::getDirection

(

)

Get current sort direction

Returns

self::ORDER_ASC|self::ORDER_DESC

getHref()

Galette\Core\Pagination::getHref ( int  $page )

protected

Build href

Parameters

int

$page

Page

Returns

string

invertorder()

Galette\Core\Pagination::invertorder

(

)

Invert sort order

Returns

void

reinit()

Galette\Core\Pagination::reinit

(

)

Reinit default parameters

Returns

void

Reimplemented in Galette\Filters\TransactionsList, Galette\Filters\MembersList, Galette\Filters\MailingsList, Galette\Filters\HistoryList, and Galette\Filters\AdvancedMembersList.

setCounter()

Galette\Core\Pagination::setCounter

(

int

$c

)

Set counter

Parameters

int

$c

Count

Returns

void

setDirection()

Galette\Core\Pagination::setDirection

(

string

$direction

)

Set sort direction

Parameters

string

$direction

self::ORDER_ASC|self::ORDER_DESC

Returns

void

setLimits()

Galette\Core\Pagination::setLimits

(

Select

$select

)

Add limits so we retrieve only relavant rows

Parameters

Select

$select

Original select

Returns

void

setViewPagination()

Galette\Core\Pagination::setViewPagination	(	RouteParser	$routeparser,
		Twig	$view,
		bool	$restricted = true
	)

Creates pagination links and assign some useful variables to the template

Parameters

RouteParser	$routeparser	Application instance
Twig	$view	View instance
boolean	$restricted	Do not permit to display all

Returns

void

Member Data Documentation

$pagination_fields

array Galette\Core\Pagination::$pagination_fields

protected

Initial value:

= array(
        'current_page',
        'orderby',
        'ordered',
        'show',
        'pages',
        'counter'
    )

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/Core/Pagination.php