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

Public Member Functions

 __construct ()
 
 addRights ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteRights ($args, $request)
 
 editRights ($args, $request)
 
 getPublication ()
 
 getPublicationFormat ()
 
 getRequestArgs ()
 
 getRowInstance ()
 
 getSubmission ()
 
 initialize ($request, $args=null)
 
 loadData ($request, $filter=null)
 
 setPublication ($publication)
 
 setPublicationFormat ($publicationFormat)
 
 setSubmission ($submission)
 
 updateRights ($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

 $_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 sales rights.

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

Constructor & Destructor Documentation

◆ __construct()

SalesRightsGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 43 of file SalesRightsGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addRights()

SalesRightsGridHandler::addRights (   $args,
  $request 
)

Edit a new (empty) rights entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 247 of file SalesRightsGridHandler.inc.php.

References editRights().

◆ authorize()

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

Reimplemented from GridHandler.

Definition at line 112 of file SalesRightsGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteRights()

SalesRightsGridHandler::deleteRights (   $args,
  $request 
)

Delete a sales rights entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 330 of file SalesRightsGridHandler.inc.php.

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

◆ editRights()

SalesRightsGridHandler::editRights (   $args,
  $request 
)

Edit a sales rights entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 257 of file SalesRightsGridHandler.inc.php.

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

Referenced by addRights().

◆ getPublication()

SalesRightsGridHandler::getPublication ( )

Get the publication associated with this grid.

Returns
Publicaton

Definition at line 75 of file SalesRightsGridHandler.inc.php.

Referenced by deleteRights(), editRights(), getRequestArgs(), initialize(), and updateRights().

◆ getPublicationFormat()

SalesRightsGridHandler::getPublicationFormat ( )

Get the publication format assocated with these sales rights

Returns
PublicationFormat

Definition at line 91 of file SalesRightsGridHandler.inc.php.

References $_publicationFormat.

Referenced by getRequestArgs(), and loadData().

◆ getRequestArgs()

SalesRightsGridHandler::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 219 of file SalesRightsGridHandler.inc.php.

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

Referenced by initialize().

◆ getRowInstance()

SalesRightsGridHandler::getRowInstance ( )
See also
GridHandler::getRowInstance()
Returns
SalesRightsGridRow

Reimplemented from GridHandler.

Definition at line 210 of file SalesRightsGridHandler.inc.php.

References getSubmission().

Referenced by updateRights().

◆ getSubmission()

SalesRightsGridHandler::getSubmission ( )

Get the submission associated with this grid.

Returns
Submission

Definition at line 59 of file SalesRightsGridHandler.inc.php.

References $_submission.

Referenced by editRights(), getRequestArgs(), getRowInstance(), initialize(), and updateRights().

◆ initialize()

◆ loadData()

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

Reimplemented from GridHandler.

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

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

◆ setPublication()

SalesRightsGridHandler::setPublication (   $publication)

Set the Publicaton

Parameters
Publicaton

Definition at line 83 of file SalesRightsGridHandler.inc.php.

Referenced by initialize().

◆ setPublicationFormat()

SalesRightsGridHandler::setPublicationFormat (   $publicationFormat)

Set the publication format

Parameters
PublicationFormat

Definition at line 99 of file SalesRightsGridHandler.inc.php.

Referenced by initialize().

◆ setSubmission()

SalesRightsGridHandler::setSubmission (   $submission)

Set the Submission

Parameters
Submission

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

Referenced by initialize().

◆ updateRights()

SalesRightsGridHandler::updateRights (   $args,
  $request 
)

Update a sales rights entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 279 of file SalesRightsGridHandler.inc.php.

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

Field Documentation

◆ $_publicationFormat

PublicationFormat SalesRightsGridHandler::$_publicationFormat

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

Referenced by getPublicationFormat().

◆ $_submission

Submission SalesRightsGridHandler::$_submission

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

Referenced by getSubmission().


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