Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
GridRow Class Reference
Inheritance diagram for GridRow:
GridBodyElement AddThisStatisticsGridRow AnnouncementGridRow AnnouncementTypeGridRow ApprovedProofFilesGridRow CategoryGridRow ContextGridRow ContributorGridRow EventLogGridRow GenreGridRow GridCategoryRow IdentificationCodeGridRow LanguageGridRow LibraryFileGridRow ListbuilderGridRow MarketsGridRow NotificationsGridRow PKPAuthorGridRow PKPCitationGridRow PKPFilterGridRow PKPPluginGridRow PKPPreparedEmailsGridRow PublicationDateGridRow PublicationFormatGridRow RepresentativesGridRow ReviewerGridRow ReviewerSelectGridRow SalesRightsGridRow SeriesGridRow SignoffGridRow SocialMediaGridRow SponsorGridRow SpotlightsGridRow StageParticipantGridRow SubmissionChecklistGridRow SubmissionFilesGridRow UserGridRow UserGroupGridRow

Public Member Functions

 addAction ($action, $position=GRID_ACTION_POSITION_DEFAULT)
 
 getActions ($position=GRID_ACTION_POSITION_DEFAULT)
 
getData ()
 
 getGridId ()
 
 getIsModified ()
 
 getNoActionMessage ()
 
 getRequestArgs ()
 
 getTemplate ()
 
 GridRow ()
 
 hasActions ()
 
 initialize ($request, $template=null)
 
 setData (&$data)
 
 setGridId ($gridId)
 
 setIsModified ($isModified)
 
 setNoActionMessage ($message)
 
 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)
 

Public Attributes

 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_data
 
 $_gridId
 
 $_isModified
 
 $_noActionMessage
 
 $_template
 
- Public Attributes inherited from GridBodyElement
 $_cellProvider
 
 $_flags
 
 $_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::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 187 of file GridRow.inc.php.

GridRow::getGridId ( )

Get the grid id

Returns
string

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

Referenced by GenreGridRow\initialize(), LanguageGridRow\initialize(), and UserGridRow\initialize().

GridRow::getIsModified ( )

Get the modified flag for the row

Returns
boolean

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

GridRow::getNoActionMessage ( )

Get the no action message for this row.

Returns
string

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

GridRow::getRequestArgs ( )

Get the grid request parameters.

See Also
GridHandler::getRequestArgs()
Returns
array

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

Referenced by CategoryGridRow\initialize(), and UserGridRow\initialize().

GridRow::getTemplate ( )

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

Returns
string

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

GridRow::GridRow ( )

Constructor.

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

GridRow::hasActions ( )

Get whether this row has any actions or not.

Returns
boolean

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

GridRow::initialize (   $request,
  $template = null 
)

Initialize a row instance.

Subclasses can override this method.

Parameters
$requestRequest
$templatestring

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

GridRow::setData ( $data)

Set the data element(s) for this controller

Parameters
$datamixed

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

GridRow::setGridId (   $gridId)

Set the grid id

Parameters
$gridIdstring

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

GridRow::setIsModified (   $isModified)

Set the modified flag for the row

Parameters
$isModifiedboolean

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

GridRow::setNoActionMessage (   $message)

Set the no action message for the row.

Parameters
$messagestring

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

GridRow::setRequestArgs (   $requestArgs)

Set the grid request parameters.

See Also
GridHandler::getRequestArgs()
Parameters
$requestArgsarray

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

GridRow::setTemplate (   $template)

Set the controller template

Parameters
$templatestring

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

Referenced by addAction(), and AddThisStatisticsGridRow\initialize().

Member Data Documentation

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 65 of file GridRow.inc.php.

mixed GridRow::$_data

the row's data source

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

Referenced by AddThisStatisticsGridRow\initialize(), and SocialMediaGridRow\initialize().

the GridRow::$_gridId

grid this row belongs to

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

boolean GridRow::$_isModified

true if the row has been modified

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

string GridRow::$_noActionMessage

an optional message to display as a 'grid action' in place of real grid actions

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

string GridRow::$_template

the row template

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


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