Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
GridFeature Class Reference
Inheritance diagram for GridFeature:
GridCategoryAccordionFeature OrderItemsFeature PagingFeature SelectableItemsFeature OrderCategoryGridItemsFeature OrderGridItemsFeature OrderListbuilderItemsFeature OrderMultipleListsItemsFeature

Public Member Functions

 addOptions ($options)
 
 fetchGrid ($args)
 
 fetchRow ($args)
 
 fetchUIElements ($request, $grid)
 
 getGridDataElements ($args)
 
 getGridRangeInfo ($args)
 
 getId ()
 
 getInitializedCategoryRowInstance ($args)
 
 getInitializedRowInstance ($args)
 
 getJSClass ()
 
 getOptions ()
 
 getRequestArgs ($args)
 
 GridFeature ($id)
 
 gridInitialize ($args)
 
 loadData ($args)
 
 saveSequence ($args)
 
 setGridDataElements ($args)
 
 setId ($id)
 
 setOptions ($request, $grid)
 

Detailed Description

Base grid feature class. A feature is a type of plugin specific to the grid widgets. It provides several hooks to allow injection of additional grid functionality. This class implements template methods to be extendeded by subclasses.

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

Member Function Documentation

GridFeature::addOptions (   $options)

Add feature js class options.

Parameters
$optionsarray $optionId => $optionValue

Definition at line 74 of file GridFeature.inc.php.

References fetchUIElements().

Referenced by OrderCategoryGridItemsFeature\OrderCategoryGridItemsFeature().

GridFeature::fetchGrid (   $args)

Hook called on grid fetching.

Parameters
$argsarray 'grid' => GridHandler

Definition at line 218 of file GridFeature.inc.php.

GridFeature::fetchRow (   $args)

Hook called after a row is fetched.

Parameters
$argsarray 'request' => PKPRequest 'grid' => GridHandler 'row' => mixed GridRow or null 'jsonMessage' => JSONMessage

Definition at line 233 of file GridFeature.inc.php.

GridFeature::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

Definition at line 110 of file GridFeature.inc.php.

Referenced by addOptions().

GridFeature::getGridDataElements (   $args)

Hook called when grid data is retrieved.

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

Definition at line 159 of file GridFeature.inc.php.

GridFeature::getGridRangeInfo (   $args)

Hook called every time the grid range info is retrieved.

Parameters
$argsarray 'request' => PKPRequest 'grid' => GridHandler 'rangeInfo' => DBResultRange

Definition at line 147 of file GridFeature.inc.php.

GridFeature::getId ( )

Get feature id.

Returns
string

Definition at line 50 of file GridFeature.inc.php.

GridFeature::getInitializedCategoryRowInstance (   $args)

Hook called on grid category row initialization.

Parameters
$argsarray 'request' => PKPRequest 'grid' => CategoryGridHandler 'categoryId' => int 'row' => GridCategoryRow

Definition at line 190 of file GridFeature.inc.php.

GridFeature::getInitializedRowInstance (   $args)

Hook called every time grid initialize a row object.

Parameters
$argsarray 'grid' => GridHandler, 'row' => GridRow

Definition at line 179 of file GridFeature.inc.php.

GridFeature::getJSClass ( )

Return the java script feature class.

Returns
string

Definition at line 118 of file GridFeature.inc.php.

GridFeature::getOptions ( )

Get feature js class options.

Returns
string

Definition at line 66 of file GridFeature.inc.php.

Referenced by OrderCategoryGridItemsFeature\getType().

GridFeature::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
$argsarray 'grid' => GridHandler 'requestArgs' => array

Definition at line 135 of file GridFeature.inc.php.

GridFeature::GridFeature (   $id)

Constructor.

Parameters
$idstring Feature id.

Definition at line 38 of file GridFeature.inc.php.

GridFeature::gridInitialize (   $args)

Hook called on grid's initialization.

Parameters
$argsarray Contains the grid handler referenced object in 'grid' array index.

Definition at line 199 of file GridFeature.inc.php.

GridFeature::loadData (   $args)

Hook called on grid's data loading.

Parameters
$argsarray 'request' => PKPRequest, 'grid' => GridHandler, 'gridData' => array

Definition at line 210 of file GridFeature.inc.php.

GridFeature::saveSequence (   $args)

Hook called when save grid items sequence is requested.

Parameters
$argsarray 'request' => PKPRequest, 'grid' => GridHandler

Definition at line 243 of file GridFeature.inc.php.

GridFeature::setGridDataElements (   $args)

Hook called before grid data is setted.

Parameters
$argsarray 'grid' => GridHandler 'data' => mixed (array or ItemIterator)

Definition at line 169 of file GridFeature.inc.php.

GridFeature::setId (   $id)

Set feature id.

Parameters
$idstring

Definition at line 58 of file GridFeature.inc.php.

GridFeature::setOptions (   $request,
  $grid 
)

Set feature js class options. Extend this method to define more feature js class options.

Parameters
$requestPKPRequest
$gridGridHandler

Definition at line 89 of file GridFeature.inc.php.


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