Inheritance diagram for GeneralPagingFeature:

Public Member Functions
	__construct ($id, $itemsPerPage=null)

	getGridDataElements ($args)

	getGridRangeInfo ($args)

	getItemIterator ()

	getRequestArgs ($args)

	setGridDataElements ($args)

	setOptions ($request, $grid)

Public Member Functions inherited from GridFeature
	__construct ($id)

	addOptions ($options)

	fetchGrid ($args)

	fetchRow ($args)

	fetchRows ($args)

	fetchUIElements ($request, $grid)

	getId ()

	getInitializedCategoryRowInstance ($args)

	getInitializedRowInstance ($args)

	getJSClass ()

	getOptions ()

	gridInitialize ($args)

	loadData ($args)

	saveSequence ($args)

	setId ($id)

Additional Inherited Members
Data Fields inherited from GridFeature
	$_id

	$_options

Detailed Description

Base class that implements common functionality for paging features.

Definition at line 20 of file GeneralPagingFeature.inc.php.

Constructor & Destructor Documentation

◆ __construct()

GeneralPagingFeature::__construct	(	$id,
		$itemsPerPage = `null`
	)

See also: GridFeature::GridFeature()

Parameters

$id	string Feature identifier.
$itemsPerPage	null\|int Optional Number of items to show at the first time. Constructor.

Reimplemented in InfiniteScrollingFeature.

Definition at line 41 of file GeneralPagingFeature.inc.php.

Member Function Documentation

◆ getGridDataElements()

GeneralPagingFeature::getGridDataElements ( $args )

Hook called when grid data is retrieved.

Parameters

$args array 'request' => PKPRequest 'grid' => GridHandler 'gridData' => mixed (array or ItemIterator) 'filter' => array

Reimplemented from GridFeature.

Definition at line 105 of file GeneralPagingFeature.inc.php.

References GridFeature\addOptions().

◆ getGridRangeInfo()

GeneralPagingFeature::getGridRangeInfo ( $args )

Hook called every time the grid range info is retrieved.

Parameters

$args array 'request' => PKPRequest 'grid' => GridHandler 'rangeInfo' => DBResultRange

Reimplemented from GridFeature.

Definition at line 152 of file GeneralPagingFeature.inc.php.

◆ getItemIterator()

GeneralPagingFeature::getItemIterator ( )

Get item iterator.

Returns: ItemIterator

Definition at line 54 of file GeneralPagingFeature.inc.php.

Referenced by PagingFeature\fetchRow(), InfiniteScrollingFeature\fetchUIElements(), PagingFeature\fetchUIElements(), and setOptions().

◆ getRequestArgs()

GeneralPagingFeature::getRequestArgs ( $args )

Hook called every time grid request args are required. Note that if the specific grid implementation extends the getRequestArgs method, this hook will only be called if the extending method call its parent.

Parameters

$args array 'grid' => GridHandler 'requestArgs' => array

Reimplemented from GridFeature.

Definition at line 136 of file GeneralPagingFeature.inc.php.

References PKPApplication\get(), and PKPHandler\getPageParamName().