Open Journal Systems  3.3.0
SectionGridHandler Class Reference
Inheritance diagram for SectionGridHandler:
SetupGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 activateSection ($args, $request)
 
 addSection ($args, $request)
 
 deactivateSection ($args, $request)
 
 deleteSection ($args, $request)
 
 editSection ($args, $request)
 
 getDataElementSequence ($row)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateSection ($args, $request)
 
- Public Member Functions inherited from SetupGridHandler
 authorize ($request, &$args, $roleAssignments, $contextRequired=true)
 
 uploadImage ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow ($args, $request)
 
 fetchRows ($args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag=null)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Protected Member Functions

 getRowInstance ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Data Fields inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_constants = []
 
 $_data
 
 $_dataProvider
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle section grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

SectionGridHandler::__construct ( )

Constructor

Reimplemented from SetupGridHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ activateSection()

SectionGridHandler::activateSection (   $args,
  $request 
)

Activate a section.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 329 of file SectionGridHandler.inc.php.

References DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ addSection()

SectionGridHandler::addSection (   $args,
  $request 
)

An action to add a new section

Parameters
$argsarray
$requestPKPRequest

Definition at line 176 of file SectionGridHandler.inc.php.

References editSection().

◆ deactivateSection()

SectionGridHandler::deactivateSection (   $args,
  $request 
)

Deactivate a section.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 281 of file SectionGridHandler.inc.php.

References DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ deleteSection()

SectionGridHandler::deleteSection (   $args,
  $request 
)

Delete a section

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 227 of file SectionGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), and AppLocale\requireComponents().

◆ editSection()

SectionGridHandler::editSection (   $args,
  $request 
)

An action to edit a section

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object
JSONMessage JSON object

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

References PKPHandler\setupTemplate().

Referenced by addSection().

◆ getDataElementSequence()

SectionGridHandler::getDataElementSequence (   $row)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Reimplemented from GridHandler.

Definition at line 153 of file SectionGridHandler.inc.php.

◆ getRowInstance()

SectionGridHandler::getRowInstance ( )
protected

Get the row handler - override the default row handler

Returns
SectionGridRow

Reimplemented from GridHandler.

Definition at line 146 of file SectionGridHandler.inc.php.

◆ initFeatures()

SectionGridHandler::initFeatures (   $request,
  $args 
)

Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.

Parameters
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 137 of file SectionGridHandler.inc.php.

◆ initialize()

SectionGridHandler::initialize (   $request,
  $args = null 
)

◆ setDataElementSequence()

SectionGridHandler::setDataElementSequence (   $request,
  $rowId,
  $gridDataElement,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

Definition at line 160 of file SectionGridHandler.inc.php.

References DAORegistry\getDAO().

◆ updateSection()

SectionGridHandler::updateSection (   $args,
  $request 
)

Update a section

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 205 of file SectionGridHandler.inc.php.

References DAO\getDataChangedEvent().


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