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

Public Member Functions

 __construct ($overrideRowTemplate, $nonOrderableItemMessage=null)
 
 addRowOrderAction ($row)
 
 fetchUIElements ($request, $grid)
 
 getInitializedRowInstance ($args)
 
 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 ()
 
 getInitializedCategoryRowInstance ($args)
 
 getJSClass ()
 
 getOptions ()
 
 getRequestArgs ($args)
 
 loadData ($args)
 
 saveSequence ($args)
 
 setGridDataElements ($args)
 
 setId ($id)
 

Data Fields

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

Detailed Description

Base class for grid widgets ordering functionality.

Definition at line 19 of file OrderItemsFeature.inc.php.

Constructor & Destructor Documentation

◆ __construct()

OrderItemsFeature::__construct (   $overrideRowTemplate,
  $nonOrderableItemMessage = null 
)

Constructor.

Parameters
$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.
$nonOrderableItemMessagestring optional A translated message to be used when user tries to move a non orderable grid item.

Reimplemented in OrderGridItemsFeature.

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

References setNonOrderableItemMessage(), and setOverrideRowTemplate().

Member Function Documentation

◆ addRowOrderAction()

OrderItemsFeature::addRowOrderAction (   $row)

Add grid row order action.

Parameters
$rowGridRow
$actionPositionint
$rowTemplatestring

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

References getOverrideRowTemplate().

Referenced by OrderCategoryGridItemsFeature\getInitializedCategoryRowInstance(), and getInitializedRowInstance().

◆ fetchUIElements()

OrderItemsFeature::fetchUIElements (   $request,
  $grid 
)

◆ getInitializedRowInstance()

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

Reimplemented from GridFeature.

Reimplemented in OrderCategoryGridItemsFeature.

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

References addRowOrderAction().

◆ getNonOrderableItemMessage()

OrderItemsFeature::getNonOrderableItemMessage ( )

Get non orderable item message.

Returns
string Message already translated.

Definition at line 87 of file OrderItemsFeature.inc.php.

References $_nonOrderableItemMessage.

Referenced by fetchUIElements().

◆ getOverrideRowTemplate()

OrderItemsFeature::getOverrideRowTemplate ( $gridRow)

Get override row template flag.

Parameters
$gridRowGridRow
Returns
boolean

Definition at line 65 of file OrderItemsFeature.inc.php.

References $_overrideRowTemplate.

Referenced by addRowOrderAction().

◆ gridInitialize()

OrderItemsFeature::gridInitialize (   $args)
See also
GridFeature::gridInitialize()

Reimplemented from GridFeature.

Definition at line 143 of file OrderItemsFeature.inc.php.

References isOrderActionNecessary().

◆ isOrderActionNecessary()

OrderItemsFeature::isOrderActionNecessary ( )

Return if this feature will use a grid level order action. Default is true, override it if needed.

Returns
boolean

Definition at line 194 of file OrderItemsFeature.inc.php.

Referenced by fetchUIElements(), and gridInitialize().

◆ setNonOrderableItemMessage()

OrderItemsFeature::setNonOrderableItemMessage (   $nonOrderableItemMessage)

Set non orderable item message.

Parameters
$nonOrderableItemMessagestring Message already translated.

Definition at line 79 of file OrderItemsFeature.inc.php.

Referenced by __construct().

◆ setOptions()

OrderItemsFeature::setOptions (   $request,
  $grid 
)
See also
GridFeature::setOptions()

Reimplemented from GridFeature.

Definition at line 98 of file OrderItemsFeature.inc.php.

References GridFeature\addOptions().

◆ setOverrideRowTemplate()

OrderItemsFeature::setOverrideRowTemplate (   $overrideRowTemplate)

Set override row template flag.

Parameters
$customRowTemplateboolean

Definition at line 56 of file OrderItemsFeature.inc.php.

Referenced by __construct().

Field Documentation

◆ $_nonOrderableItemMessage

string OrderItemsFeature::$_nonOrderableItemMessage

Definition at line 30 of file OrderItemsFeature.inc.php.

Referenced by getNonOrderableItemMessage().

◆ $_overrideRowTemplate

boolean OrderItemsFeature::$_overrideRowTemplate

Definition at line 24 of file OrderItemsFeature.inc.php.

Referenced by getOverrideRowTemplate().


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