Open Journal Systems  3.3.0
TocGridHandler Class Reference
Inheritance diagram for TocGridHandler:
CategoryGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 getCategoryRowIdParameterName ()
 
 getDataElementInCategorySequence ($categoryId, &$submission)
 
 getDataElementSequence ($object)
 
 getRequestArgs ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 loadCategoryData ($request, &$section, $filter=null)
 
 removeArticle ($args, $request)
 
 setAccessStatus ($args, $request)
 
 setDataElementInCategorySequence ($sectionId, &$submission, $newSequence)
 
 setDataElementSequence ($request, $sectionId, $gridDataElement, $newSequence)
 
- Public Member Functions inherited from CategoryGridHandler
 __construct ($dataProvider=null)
 
 fetchCategory ($args, $request)
 
 getCategoryItemsCount ($categoryElement, $request)
 
 getCurrentCategoryId ()
 
 getEmptyCategoryRowText ()
 
getGridCategoryDataElements ($request, $categoryElement)
 
 getJSHandler ()
 
 hasGridDataElementsInCategory ($categoryElement, $request)
 
 isDataElementInCategorySelected ($categoryId, &$gridDataElement)
 
 setEmptyCategoryRowText ($translationKey)
 
 setGridCategoryDataElements ($request, $categoryElementId, $data)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 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 ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 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)
 
- 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)
 

Data Fields

 $submissionsBySectionId = []
 
- Data Fields inherited from CategoryGridHandler
 $_categoryData
 
 $_currentCategoryId = null
 
 $_emptyCategoryRowText = 'grid.noItems'
 
- 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 Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle TOC (table of contents) grid requests.

Definition at line 20 of file TocGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

TocGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 26 of file TocGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

TocGridHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from GridHandler.

Definition at line 42 of file TocGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ getCategoryRowIdParameterName()

TocGridHandler::getCategoryRowIdParameterName ( )

Get the category row id parameter name.

Returns
string

Reimplemented from CategoryGridHandler.

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

◆ getCategoryRowInstance()

TocGridHandler::getCategoryRowInstance ( )
protected

Get a new instance of a category grid row. May be overridden by subclasses if they want to provide a custom row definition.

Returns
CategoryGridRow

Reimplemented from CategoryGridHandler.

Definition at line 130 of file TocGridHandler.inc.php.

◆ getDataElementInCategorySequence()

TocGridHandler::getDataElementInCategorySequence (   $categoryId,
$submission 
)

Override to return the data element sequence value inside the passed category, if needed.

Parameters
$categoryIdint The data element category id.
$gridDataElementmixed The element to return the sequence.
Returns
int

Reimplemented from CategoryGridHandler.

Definition at line 196 of file TocGridHandler.inc.php.

◆ getDataElementSequence()

TocGridHandler::getDataElementSequence (   $object)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int
Parameters
Section | Submission$object

Reimplemented from GridHandler.

Definition at line 166 of file TocGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

◆ getRequestArgs()

TocGridHandler::getRequestArgs ( )

Get an array with all request parameters necessary to uniquely identify the data selection of this data provider.

Returns
array

Reimplemented from CategoryGridHandler.

Definition at line 110 of file TocGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ getRowInstance()

TocGridHandler::getRowInstance ( )
protected

Get the row handler - override the default row handler

Returns
TocGridRow

Reimplemented from GridHandler.

Definition at line 122 of file TocGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ initFeatures()

TocGridHandler::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 96 of file TocGridHandler.inc.php.

◆ initialize()

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

See also
PKPHandler::initialize()
Parameters
$requestPKPRequest
$argsarray optional

Reimplemented from CategoryGridHandler.

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

References GridHandler\addColumn(), PKPHandler\getAuthorizedContextObject(), and AppLocale\requireComponents().

◆ loadCategoryData()

TocGridHandler::loadCategoryData (   $request,
$section,
  $filter = null 
)

Implement this method to load category data into the grid.

Parameters
$requestPKPRequest
$categoryDataElementmixed
$filtermixed
Returns
array

Reimplemented from CategoryGridHandler.

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

◆ loadData()

TocGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$filterarray An associative array with filter data as returned by getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
grid data

Reimplemented from GridHandler.

Definition at line 144 of file TocGridHandler.inc.php.

References PKPServices\get(), PKPApplication\get(), and PKPHandler\getAuthorizedContextObject().

◆ removeArticle()

TocGridHandler::removeArticle (   $args,
  $request 
)

Remove an article from the issue.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 221 of file TocGridHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ setAccessStatus()

TocGridHandler::setAccessStatus (   $args,
  $request 
)

Set access status on an article.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 262 of file TocGridHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ setDataElementInCategorySequence()

TocGridHandler::setDataElementInCategorySequence (   $sectionId,
$submission,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from CategoryGridHandler.

Definition at line 203 of file TocGridHandler.inc.php.

References PKPServices\get(), and PKPApplication\get().

◆ setDataElementSequence()

TocGridHandler::setDataElementSequence (   $request,
  $sectionId,
  $gridDataElement,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

Definition at line 184 of file TocGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

Field Documentation

◆ $submissionsBySectionId

TocGridHandler::$submissionsBySectionId = []

Definition at line 21 of file TocGridHandler.inc.php.


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