Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
GridRow Class Reference
Inheritance diagram for GridRow:
GridBodyElement GridCategoryRow ListbuilderGridRow PKPCitationGridRow PKPFilterGridRow

Public Member Functions

 addAction ($action, $position=GRID_ACTION_POSITION_DEFAULT)
 
 getActions ($position=GRID_ACTION_POSITION_DEFAULT)
 
getData ()
 
 getGridId ()
 
 getIsModified ()
 
 getRequestArgs ()
 
 getTemplate ()
 
 GridRow ()
 
 hasActions ()
 
 initialize ($request, $template= 'controllers/grid/gridRow.tpl')
 
 setData (&$data)
 
 setGridId ($gridId)
 
 setIsModified ($isModified)
 
 setRequestArgs ($requestArgs)
 
 setTemplate ($template)
 
- Public Member Functions inherited from GridBodyElement
 addFlag ($flag, $value=true)
 
getCellProvider ()
 
 getFlag ($flag)
 
 getFlags ()
 
 getId ()
 
 GridBodyElement ($id= '', $cellProvider=null, $flags=array())
 
 hasFlag ($flag)
 
 setCellProvider (&$cellProvider)
 
 setId ($id)
 

Detailed Description

Class defining basic operations for handling HTML gridRows.

NB: If you want row-level refresh then you must override the getData() method so that it fetches data (e.g. from the database) when called. The data to be fetched can be determined from the id (=row id) which is always set.

Definition at line 25 of file GridRow.inc.php.

Member Function Documentation

GridRow::addAction (   $action,
  $position = GRID_ACTION_POSITION_DEFAULT 
)

Add an action

Parameters
$positionstring the position of the action
$actionmixed a single action

Definition at line 157 of file GridRow.inc.php.

Referenced by PKPFilterGridRow\initialize(), and PKPCitationGridRow\initialize().

GridRow::getActions (   $position = GRID_ACTION_POSITION_DEFAULT)

Get all actions for a given position within the controller

Parameters
$positionstring the position of the actions
Returns
array the LegacyLinkActions for the given position

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

& GridRow::getData ( )

Get the data element(s) for this controller

Returns
mixed

Definition at line 109 of file GridRow.inc.php.

Referenced by PKPCitationGridRow\getCellActions(), and PKPFilterGridRow\initialize().

GridRow::getGridId ( )

Get the grid id

Returns
string

Definition at line 75 of file GridRow.inc.php.

GridRow::getIsModified ( )

Get the modified flag for the row

Returns
boolean

Definition at line 125 of file GridRow.inc.php.

GridRow::getRequestArgs ( )

Get the grid request parameters.

See Also
GridHandler::getRequestArgs()
Returns
array

Definition at line 93 of file GridRow.inc.php.

GridRow::getTemplate ( )

Get the row template - override base implementation to provide a sensible default.

Returns
string

Definition at line 167 of file GridRow.inc.php.

GridRow::GridRow ( )

Constructor.

Definition at line 53 of file GridRow.inc.php.

GridRow::hasActions ( )

Get whether this row has any actions or not.

Returns
boolean

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

GridRow::initialize (   $request,
  $template = 'controllers/grid/gridRow.tpl' 
)

Initialize a row instance.

Subclasses can override this method.

Parameters
$requestRequest
$templatestring

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

References setTemplate().

GridRow::setData ( $data)

Set the data element(s) for this controller

Parameters
$datamixed

Definition at line 101 of file GridRow.inc.php.

GridRow::setGridId (   $gridId)

Set the grid id

Parameters
$gridIdstring

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

GridRow::setIsModified (   $isModified)

Set the modified flag for the row

Parameters
$isModifiedboolean

Definition at line 117 of file GridRow.inc.php.

GridRow::setRequestArgs (   $requestArgs)

Set the grid request parameters.

See Also
GridHandler::getRequestArgs()
Parameters
$requestArgsarray

Definition at line 84 of file GridRow.inc.php.

GridRow::setTemplate (   $template)

Set the controller template

Parameters
$templatestring

Definition at line 175 of file GridRow.inc.php.

Referenced by ListbuilderGridRow\initialize(), and initialize().


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