Open Journal Systems  3.3.0
GridRow Class Reference
Inheritance diagram for GridRow:
GridBodyElement AnnouncementTypeGridRow ArticleGalleyGridRow AuthorGridRow AuthorReviewerGridRow CategoryGridRow ContextGridRow CustomBlockGridRow EventLogGridRow GenreGridRow GridCategoryRow IssueGalleyGridRow IssueGridRow LanguageGridRow LibraryFileGridRow ListbuilderGridRow NavigationMenuItemsGridRow NavigationMenusGridRow PLNStatusGridRow PluginGridRow QueriesGridRow QueryNotesGridRow ReviewerGridRow ReviewFormElementGridRow ReviewFormGridRow SectionGridRow StageParticipantGridRow StaticPageGridRow SubmissionChecklistGridRow SubmissionFilesGridRow SubscriptionsGridRow SubscriptionTypesGridRow SwordDepositPointsGridRow TocGridRow UserGridRow UserGroupGridRow

Public Member Functions

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

Data Fields

 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_data
 
 $_gridId
 
 $_isModified
 
 $_requestArgs
 
 $_template
 
- Data Fields inherited from GridBodyElement
 $_cellProvider
 
 $_flags
 
 $_id
 

Detailed Description

GridRow implements a row of a Grid. See GridHandler for general information about grids.

Each Grid is populated with data that is displayed in a series of rows. Each row is implemented using a GridRow, which knows how to describe the data it represents, and can present and manage row actions such as Edit and Delete operations.

For general information on grids, see GridHandler.

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

Constructor & Destructor Documentation

◆ __construct()

GridRow::__construct ( )

Constructor.

Reimplemented in GridCategoryRow.

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

Member Function Documentation

◆ addAction()

◆ getActions()

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 LinkActions for the given position

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

◆ getData()

◆ getGridId()

◆ getIsModified()

GridRow::getIsModified ( )

Get the modified flag for the row

Returns
boolean

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

References $_isModified.

◆ getRequestArgs()

◆ getTemplate()

GridRow::getTemplate ( )

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

Returns
string

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

References $_template.

◆ hasActions()

GridRow::hasActions ( )

Get whether this row has any actions or not.

Returns
boolean

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

◆ initialize()

◆ setData()

GridRow::setData ( $data)

Set the data element(s) for this controller

Parameters
$datamixed

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

◆ setGridId()

GridRow::setGridId (   $gridId)

Set the grid id

Parameters
$gridIdstring

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

◆ setIsModified()

GridRow::setIsModified (   $isModified)

Set the modified flag for the row

Parameters
$isModifiedboolean

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

◆ setRequestArgs()

GridRow::setRequestArgs (   $requestArgs)

Set the grid request parameters.

See also
GridHandler::getRequestArgs()
Parameters
$requestArgsarray

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

Referenced by IssueGalleyGridRow\__construct(), and UserGroupGridRow\initialize().

◆ setTemplate()

GridRow::setTemplate (   $template)

Set the controller template

Parameters
$templatestring

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

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

Field Documentation

◆ $_actions

array GridRow::$_actions = array(GRID_ACTION_POSITION_DEFAULT => array())

row actions, the first key represents the position of the action in the row template, the second key represents the action id.

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

◆ $_data

mixed GridRow::$_data

the row's data source

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

Referenced by getData().

◆ $_gridId

the GridRow::$_gridId

grid this row belongs to

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

Referenced by getGridId().

◆ $_isModified

boolean GridRow::$_isModified

true if the row has been modified

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

Referenced by getIsModified().

◆ $_requestArgs

array GridRow::$_requestArgs

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

Referenced by getRequestArgs().

◆ $_template

string GridRow::$_template

the row template

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

Referenced by getTemplate().


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