Open Journal Systems  3.3.0
FileNameGridColumn Class Reference
Inheritance diagram for FileNameGridColumn:
GridColumn GridBodyElement

Public Member Functions

 __construct ($includeNotes=true, $stageId=null, $removeHistoryTab=false)
 
 _getIncludeNotes ()
 
 _getStageId ()
 
 getCellActions ($request, $row, $position=GRID_ACTION_POSITION_DEFAULT)
 
 getTemplateVarsFromRow ($row)
 
- Public Member Functions inherited from GridColumn
 __construct ($id='', $title=null, $titleTranslated=null, $template=null, $cellProvider=null, $flags=array())
 
 getCellProvider ()
 
 getLocalizedTitle ()
 
 getTemplate ()
 
 getTitle ()
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setTitleTranslated ($titleTranslated)
 
- Public Member Functions inherited from GridBodyElement
 addFlag ($flag, $value=true)
 
 getFlag ($flag)
 
 getFlags ()
 
 getId ()
 
 hasFlag ($flag)
 
 setCellProvider ($cellProvider)
 
 setId ($id)
 

Data Fields

 $_includeNotes
 
 $_removeHistoryTab
 
 $_stageId
 
- Data Fields inherited from GridColumn
 $_template
 
 $_title
 
 $_titleTranslated
 
- Data Fields inherited from GridBodyElement
 $_cellProvider
 
 $_flags
 
 $_id
 

Detailed Description

Implements a file name column.

Definition at line 18 of file FileNameGridColumn.inc.php.

Constructor & Destructor Documentation

◆ __construct()

FileNameGridColumn::__construct (   $includeNotes = true,
  $stageId = null,
  $removeHistoryTab = false 
)

Constructor

Parameters
$includeNotesboolean
$stageIdint (optional)
$removeHistoryTabboolean (optional) Open the information center without the history tab.

Reimplemented from GridBodyElement.

Definition at line 44 of file FileNameGridColumn.inc.php.

Member Function Documentation

◆ _getIncludeNotes()

FileNameGridColumn::_getIncludeNotes ( )

Determine whether or not submission note status should be included.

Definition at line 103 of file FileNameGridColumn.inc.php.

References $_includeNotes.

◆ _getStageId()

FileNameGridColumn::_getStageId ( )

Get stage id, if any.

Returns
mixed int or null

Definition at line 111 of file FileNameGridColumn.inc.php.

References $_stageId.

Referenced by getCellActions().

◆ getCellActions()

FileNameGridColumn::getCellActions (   $request,
  $row,
  $position = GRID_ACTION_POSITION_DEFAULT 
)

Get cell actions for this column.

NB: Subclasses have to override this method to actually provide cell-specific actions. The default implementation returns an empty array.

Parameters
$rowGridRow The row for which actions are being requested.
Returns
array An array of LinkActions for the cell.

Reimplemented from GridColumn.

Definition at line 82 of file FileNameGridColumn.inc.php.

References _getStageId().

◆ getTemplateVarsFromRow()

FileNameGridColumn::getTemplateVarsFromRow (   $row)

Method expected by ColumnBasedGridCellProvider to render a cell in this column.

See also
GridCellProvider::getTemplateVarsFromRowColumn()

Definition at line 66 of file FileNameGridColumn.inc.php.

Field Documentation

◆ $_includeNotes

boolean FileNameGridColumn::$_includeNotes

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

Referenced by _getIncludeNotes().

◆ $_removeHistoryTab

boolean FileNameGridColumn::$_removeHistoryTab

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

◆ $_stageId

int FileNameGridColumn::$_stageId

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

Referenced by _getStageId().


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