Open Journal Systems  3.3.0
InfiniteScrollingFeature Class Reference
Inheritance diagram for InfiniteScrollingFeature:
GeneralPagingFeature GridFeature

Public Member Functions

 __construct ($id='infiniteScrolling', $itemsPerPage=null)
 
 fetchRow ($args)
 
 fetchRows ($args)
 
 fetchUIElements ($request, $grid)
 
 getJSClass ()
 
- Public Member Functions inherited from GeneralPagingFeature
 getGridDataElements ($args)
 
 getGridRangeInfo ($args)
 
 getItemIterator ()
 
 getRequestArgs ($args)
 
 setGridDataElements ($args)
 
 setOptions ($request, $grid)
 
- Public Member Functions inherited from GridFeature
 __construct ($id)
 
 addOptions ($options)
 
 fetchGrid ($args)
 
 getId ()
 
 getInitializedCategoryRowInstance ($args)
 
 getInitializedRowInstance ($args)
 
 getOptions ()
 
 gridInitialize ($args)
 
 loadData ($args)
 
 saveSequence ($args)
 
 setId ($id)
 

Additional Inherited Members

- Data Fields inherited from GridFeature
 $_id
 
 $_options
 

Detailed Description

Add infinite scrolling functionality to grids. It doesn't support category grids.

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

Constructor & Destructor Documentation

◆ __construct()

InfiniteScrollingFeature::__construct (   $id = 'infiniteScrolling',
  $itemsPerPage = null 
)

Constructor.

Reimplemented from GeneralPagingFeature.

Definition at line 26 of file InfiniteScrollingFeature.inc.php.

Member Function Documentation

◆ fetchRow()

InfiniteScrollingFeature::fetchRow (   $args)

Hook called after a row is fetched.

Parameters
$argsarray 'request' => PKPRequest 'grid' => GridHandler 'row' => mixed GridRow or null 'jsonMessage' => JSONMessage Check if user really deleted a row and fetch the last one from the current page.

Reimplemented from GridFeature.

Definition at line 103 of file InfiniteScrollingFeature.inc.php.

References GridFeature\getOptions(), and GeneralPagingFeature\setOptions().

◆ fetchRows()

InfiniteScrollingFeature::fetchRows (   $args)

Hook called after a group of rows is fetched.

Parameters
$argsarray 'request' => PKPRequest 'grid' => GridHandler 'jsonMessage' => JSONMessage

Reimplemented from GridFeature.

Definition at line 81 of file InfiniteScrollingFeature.inc.php.

References GridFeature\getOptions(), and GeneralPagingFeature\setOptions().

◆ fetchUIElements()

InfiniteScrollingFeature::fetchUIElements (   $request,
  $grid 
)

Fetch any user interface elements that this feature needs to add its functionality into the grid. Use this only for ui elements that grid will not fetch itself.

Parameters
$requestPKPRequest
$gridGridHandler The grid that this feature is attached to.
Returns
array It is expected that the array returns data in this format: $elementId => $elementMarkup

Reimplemented from GridFeature.

Definition at line 44 of file InfiniteScrollingFeature.inc.php.

References GeneralPagingFeature\getItemIterator(), PKPTemplateManager\getManager(), and GridFeature\getOptions().

◆ getJSClass()

InfiniteScrollingFeature::getJSClass ( )

Return the java script feature class.

Returns
string|null

Reimplemented from GridFeature.

Definition at line 37 of file InfiniteScrollingFeature.inc.php.


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