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

Public Member Functions

 __construct ()
 
 add ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 delete ($args, $request)
 
 download ($args, $request)
 
 edit ($args, $request)
 
 getDataElementSequence ($issueGalley)
 
 getRequestArgs ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 update ($args, $request)
 
 upload ($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)
 
 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)
 
 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 ()
 
 loadData ($request, $filter)
 
- 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 ()
 
 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 issues grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

IssueGalleyGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ add()

IssueGalleyGridHandler::add (   $args,
  $request 
)

An action to add a new issue

Parameters
$argsarray
$requestPKPRequest

Definition at line 179 of file IssueGalleyGridHandler.inc.php.

References edit().

◆ authorize()

IssueGalleyGridHandler::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 41 of file IssueGalleyGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ delete()

IssueGalleyGridHandler::delete (   $args,
  $request 
)

Removes an issue galley

Parameters
$argsarray
$requestPKPRequest

Definition at line 264 of file IssueGalleyGridHandler.inc.php.

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

◆ download()

IssueGalleyGridHandler::download (   $args,
  $request 
)

An action to download an issue galley

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

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

References PKPHandler\getAuthorizedContextObject().

◆ edit()

IssueGalleyGridHandler::edit (   $args,
  $request 
)

An action to edit a issue galley

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 191 of file IssueGalleyGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by add().

◆ getDataElementSequence()

IssueGalleyGridHandler::getDataElementSequence (   $issueGalley)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Reimplemented from GridHandler.

Definition at line 60 of file IssueGalleyGridHandler.inc.php.

◆ getRequestArgs()

IssueGalleyGridHandler::getRequestArgs ( )

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

Returns
array

Reimplemented from GridHandler.

Definition at line 84 of file IssueGalleyGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by initialize().

◆ getRowInstance()

IssueGalleyGridHandler::getRowInstance ( )
protected

Get the row handler - override the default row handler

Returns
IssueGalleyGridRow

Reimplemented from GridHandler.

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

References PKPHandler\getAuthorizedContextObject().

◆ initFeatures()

IssueGalleyGridHandler::initFeatures (   $request,
  $args 
)

Reimplemented from GridHandler.

Definition at line 76 of file IssueGalleyGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from GridHandler.

Definition at line 96 of file IssueGalleyGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), PKPHandler\getId(), getRequestArgs(), and AppLocale\requireComponents().

◆ loadData()

IssueGalleyGridHandler::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 277 of file IssueGalleyGridHandler.inc.php.

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

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

Definition at line 67 of file IssueGalleyGridHandler.inc.php.

References DAORegistry\getDAO().

◆ update()

IssueGalleyGridHandler::update (   $args,
  $request 
)

Update a issue

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 244 of file IssueGalleyGridHandler.inc.php.

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

◆ upload()

IssueGalleyGridHandler::upload (   $args,
  $request 
)

An action to upload an issue galley file.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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


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