Open Journal Systems  3.3.0
OrderCategoryGridItemsFeature Class Reference
Inheritance diagram for OrderCategoryGridItemsFeature:
OrderItemsFeature GridFeature

Public Member Functions

 __construct ($typeOption=ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS, $overrideRowTemplate=true, $grid=null)
 
 _saveRowsInCategoriesSequence ($request, &$grid, $gridCategoryElements, $data)
 
 getInitializedCategoryRowInstance ($args)
 
 getInitializedRowInstance ($args)
 
 getJSClass ()
 
 getType ()
 
 saveSequence ($args)
 
- Public Member Functions inherited from OrderItemsFeature
 __construct ($overrideRowTemplate, $nonOrderableItemMessage=null)
 
 addRowOrderAction ($row)
 
 fetchUIElements ($request, $grid)
 
 getNonOrderableItemMessage ()
 
 getOverrideRowTemplate (&$gridRow)
 
 gridInitialize ($args)
 
 isOrderActionNecessary ()
 
 setNonOrderableItemMessage ($nonOrderableItemMessage)
 
 setOptions ($request, $grid)
 
 setOverrideRowTemplate ($overrideRowTemplate)
 
- Public Member Functions inherited from GridFeature
 __construct ($id)
 
 addOptions ($options)
 
 fetchGrid ($args)
 
 fetchRow ($args)
 
 fetchRows ($args)
 
 getGridDataElements ($args)
 
 getGridRangeInfo ($args)
 
 getId ()
 
 getOptions ()
 
 getRequestArgs ($args)
 
 loadData ($args)
 
 setGridDataElements ($args)
 
 setId ($id)
 

Additional Inherited Members

- Data Fields inherited from OrderItemsFeature
 $_nonOrderableItemMessage
 
 $_overrideRowTemplate
 
- Data Fields inherited from GridFeature
 $_id
 
 $_options
 

Detailed Description

Implements category grid ordering functionality.

Definition at line 23 of file OrderCategoryGridItemsFeature.inc.php.

Constructor & Destructor Documentation

◆ __construct()

OrderCategoryGridItemsFeature::__construct (   $typeOption = ORDER_CATEGORY_GRID_CATEGORIES_AND_ROWS,
  $overrideRowTemplate = true,
  $grid = null 
)

Constructor.

Parameters
$typeOptionint Defines which grid elements will be orderable (categories and/or rows).
$overrideRowTemplateboolean This feature uses row actions and it will force the usage of the gridRow.tpl. If you want to use a different grid row template file, set this flag to false and make sure to use a template file that adds row actions.
$gridGridHandler The grid this feature is to be part of

Definition at line 35 of file OrderCategoryGridItemsFeature.inc.php.

References GridFeature\addOptions().

Member Function Documentation

◆ _saveRowsInCategoriesSequence()

OrderCategoryGridItemsFeature::_saveRowsInCategoriesSequence (   $request,
$grid,
  $gridCategoryElements,
  $data 
)

Save row elements sequence inside categories.

Parameters
$requestPKPRequest
$gridGridHandler
$gridCategoryElementsarray
$data

Definition at line 137 of file OrderCategoryGridItemsFeature.inc.php.

References getType().

Referenced by saveSequence().

◆ getInitializedCategoryRowInstance()

OrderCategoryGridItemsFeature::getInitializedCategoryRowInstance (   $args)

◆ getInitializedRowInstance()

OrderCategoryGridItemsFeature::getInitializedRowInstance (   $args)
See also
OrderItemsFeature::getInitializedRowInstance()

Reimplemented from OrderItemsFeature.

Definition at line 78 of file OrderCategoryGridItemsFeature.inc.php.

References getType().

◆ getJSClass()

OrderCategoryGridItemsFeature::getJSClass ( )
See also
GridFeature::getJSClass()

Reimplemented from GridFeature.

Definition at line 67 of file OrderCategoryGridItemsFeature.inc.php.

◆ getType()

OrderCategoryGridItemsFeature::getType ( )

Return this feature type.

Returns
int One of the ORDER_CATEGORY_GRID_... constants

Definition at line 55 of file OrderCategoryGridItemsFeature.inc.php.

References GridFeature\getOptions().

Referenced by _saveRowsInCategoriesSequence(), getInitializedCategoryRowInstance(), getInitializedRowInstance(), and saveSequence().

◆ saveSequence()

OrderCategoryGridItemsFeature::saveSequence (   $args)
See also
GridFeature::saveSequence()

Reimplemented from GridFeature.

Definition at line 97 of file OrderCategoryGridItemsFeature.inc.php.

References _saveRowsInCategoriesSequence(), and getType().


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