Open Monograph Press  3.3.0
IdentificationCodeGridHandler Class Reference
Inheritance diagram for IdentificationCodeGridHandler:
GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addCode ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteCode ($args, $request)
 
 editCode ($args, $request)
 
 getPublication ()
 
 getPublicationFormat ()
 
 getRequestArgs ()
 
 getRowInstance ()
 
 getSubmission ()
 
 initialize ($request, $args=null)
 
 loadData ($request, $filter=null)
 
 setPublication ($publication)
 
 setPublicationFormat ($publicationFormat)
 
 setSubmission ($submission)
 
 updateCode ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 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)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 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)
 

Data Fields

 $_publication
 
 $_publicationFormat
 
 $_submission
 
- 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
 

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 Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 initFeatures ($request, $args)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle publication format grid requests for identification codes.

Definition at line 27 of file IdentificationCodeGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

IdentificationCodeGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addCode()

IdentificationCodeGridHandler::addCode (   $args,
  $request 
)

Edit a new (empty) code

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 253 of file IdentificationCodeGridHandler.inc.php.

References editCode().

◆ authorize()

IdentificationCodeGridHandler::authorize (   $request,
$args,
  $roleAssignments 
)
See also
PKPHandler::authorize()
Parameters
$requestPKPRequest
$argsarray
$roleAssignmentsarray

Reimplemented from GridHandler.

Definition at line 118 of file IdentificationCodeGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteCode()

IdentificationCodeGridHandler::deleteCode (   $args,
  $request 
)

Delete a code

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 336 of file IdentificationCodeGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), PKPHandler\getId(), and getPublication().

◆ editCode()

IdentificationCodeGridHandler::editCode (   $args,
  $request 
)

Edit a code

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 263 of file IdentificationCodeGridHandler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getId(), getPublication(), and getSubmission().

Referenced by addCode().

◆ getPublication()

IdentificationCodeGridHandler::getPublication ( )

Get the publication associated with this grid.

Returns
Publication

Definition at line 81 of file IdentificationCodeGridHandler.inc.php.

References $_publication.

Referenced by deleteCode(), editCode(), getRequestArgs(), initialize(), and updateCode().

◆ getPublicationFormat()

IdentificationCodeGridHandler::getPublicationFormat ( )

Get the publication format assocated with these identification codes

Returns
PublicationFormat

Definition at line 97 of file IdentificationCodeGridHandler.inc.php.

References $_publicationFormat.

Referenced by getRequestArgs(), and loadData().

◆ getRequestArgs()

IdentificationCodeGridHandler::getRequestArgs ( )

Get the arguments that will identify the data in the grid In this case, the submission.

Returns
array

Reimplemented from GridHandler.

Definition at line 225 of file IdentificationCodeGridHandler.inc.php.

References getPublication(), getPublicationFormat(), and getSubmission().

Referenced by initialize().

◆ getRowInstance()

IdentificationCodeGridHandler::getRowInstance ( )
See also
GridHandler::getRowInstance()
Returns
IdentificationCodeGridRow

Reimplemented from GridHandler.

Definition at line 216 of file IdentificationCodeGridHandler.inc.php.

References getSubmission().

Referenced by updateCode().

◆ getSubmission()

IdentificationCodeGridHandler::getSubmission ( )

Get the submission associated with this grid.

Returns
Submission

Definition at line 65 of file IdentificationCodeGridHandler.inc.php.

References $_submission.

Referenced by editCode(), getRequestArgs(), getRowInstance(), and updateCode().

◆ initialize()

◆ loadData()

IdentificationCodeGridHandler::loadData (   $request,
  $filter = null 
)
See also
GridHandler::loadData

Reimplemented from GridHandler.

Definition at line 236 of file IdentificationCodeGridHandler.inc.php.

References DAORegistry\getDAO(), and getPublicationFormat().

◆ setPublication()

IdentificationCodeGridHandler::setPublication (   $publication)

Set the Publication

Parameters
Publication

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

Referenced by initialize().

◆ setPublicationFormat()

IdentificationCodeGridHandler::setPublicationFormat (   $publicationFormat)

Set the publication format

Parameters
PublicationFormat

Definition at line 105 of file IdentificationCodeGridHandler.inc.php.

Referenced by initialize().

◆ setSubmission()

IdentificationCodeGridHandler::setSubmission (   $submission)

Set the Submission

Parameters
Submission

Definition at line 73 of file IdentificationCodeGridHandler.inc.php.

Referenced by initialize().

◆ updateCode()

IdentificationCodeGridHandler::updateCode (   $args,
  $request 
)

Update a code

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 285 of file IdentificationCodeGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), PKPHandler\getId(), getPublication(), getRowInstance(), and getSubmission().

Field Documentation

◆ $_publication

Publication IdentificationCodeGridHandler::$_publication

Definition at line 38 of file IdentificationCodeGridHandler.inc.php.

Referenced by getPublication().

◆ $_publicationFormat

PublicationFormat IdentificationCodeGridHandler::$_publicationFormat

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

Referenced by getPublicationFormat().

◆ $_submission

Submission IdentificationCodeGridHandler::$_submission

Definition at line 32 of file IdentificationCodeGridHandler.inc.php.

Referenced by getSubmission().


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