Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
GridFeature Class Reference
Inheritance diagram for GridFeature:
GridCategoryAccordionFeature OrderItemsFeature OrderCategoryGridItemsFeature OrderGridItemsFeature OrderListbuilderItemsFeature OrderMultipleListsItemsFeature

Public Member Functions

 addOptions ($options)
 
 fetchGrid ($args)
 
 fetchUIElements (&$grid)
 
 getId ()
 
 getInitializedCategoryRowInstance ($args)
 
 getInitializedRowInstance ($args)
 
 getJSClass ()
 
 getOptions ()
 
 GridFeature ($id)
 
 gridInitialize ($args)
 
 saveSequence ($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 68 of file GridFeature.inc.php.

References getOptions().

Referenced by OrderCategoryGridItemsFeature\OrderCategoryGridItemsFeature(), OrderItemsFeature\setOptions(), and setOptions().

GridFeature::fetchGrid (   $args)

Hook called on grid fetching.

Parameters
$argsarray 'grid' => GridHandler

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

References setOptions().

GridFeature::fetchUIElements ( $grid)

Fetch any user interface elements that this feature needs to add its functionality into the grid.

Parameters
$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 102 of file GridFeature.inc.php.

Referenced by setOptions().

GridFeature::getId ( )

Get feature id.

Returns
string

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

GridFeature::getInitializedCategoryRowInstance (   $args)

Hook called on grid category row initialization.

Parameters
$argsarray 'request' => Request 'grid' => CategoryGridHandler 'row' => GridCategoryRow

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

GridFeature::getInitializedRowInstance (   $args)

Hook called every time grid initialize a row object.

Parameters
$argsarray Contains the initialized referenced row object in 'row' array index.

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

GridFeature::getJSClass ( )

Return the java script feature class.

Returns
string

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

GridFeature::getOptions ( )

Get feature js class options.

Returns
string

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

Referenced by addOptions(), and OrderCategoryGridItemsFeature\getType().

GridFeature::GridFeature (   $id)

Constructor.

Parameters
$idstring Feature id.

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

References setId().

GridFeature::gridInitialize (   $args)

Hook called on grid's initialization.

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

Definition at line 142 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 163 of file GridFeature.inc.php.

GridFeature::setId (   $id)

Set feature id.

Parameters
$idstring

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

Referenced by GridFeature().

GridFeature::setOptions ( $request,
$grid 
)

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

Parameters
$requestRequest
$gridGridHandler

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

References addOptions(), and fetchUIElements().

Referenced by fetchGrid().


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