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

Public Member Functions

 __construct ()
 
 addMarket ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteMarket ($args, $request)
 
 editMarket ($args, $request)
 
 getPublication ()
 
 getPublicationFormat ()
 
 getRequestArgs ()
 
 getRowInstance ()
 
 getSubmission ()
 
 initialize ($request, $args=null)
 
 loadData ($request, $filter=null)
 
 setPublication ($publication)
 
 setPublicationFormat ($publicationFormat)
 
 setSubmission ($submission)
 
 updateMarket ($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 markets.

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

Constructor & Destructor Documentation

◆ __construct()

MarketsGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 48 of file MarketsGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addMarket()

MarketsGridHandler::addMarket (   $args,
  $request 
)

Add a new market

Parameters
$argsarray
$requestPKPRequest

Definition at line 260 of file MarketsGridHandler.inc.php.

References editMarket().

◆ authorize()

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

Reimplemented from GridHandler.

Definition at line 117 of file MarketsGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteMarket()

MarketsGridHandler::deleteMarket (   $args,
  $request 
)

Delete a market entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 343 of file MarketsGridHandler.inc.php.

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

◆ editMarket()

MarketsGridHandler::editMarket (   $args,
  $request 
)

Edit a markets entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 270 of file MarketsGridHandler.inc.php.

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

Referenced by addMarket().

◆ getPublication()

MarketsGridHandler::getPublication ( )

Get the Publication associated with this grid.

Returns
Publication

Definition at line 80 of file MarketsGridHandler.inc.php.

References $_publication.

Referenced by deleteMarket(), editMarket(), getRequestArgs(), initialize(), and updateMarket().

◆ getPublicationFormat()

MarketsGridHandler::getPublicationFormat ( )

Get the publication format assocated with these markets

Returns
PublicationFormat

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

References $_publicationFormat.

Referenced by getRequestArgs(), and loadData().

◆ getRequestArgs()

MarketsGridHandler::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 233 of file MarketsGridHandler.inc.php.

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

Referenced by initialize().

◆ getRowInstance()

MarketsGridHandler::getRowInstance ( )
See also
GridHandler::getRowInstance()
Returns
MarketsGridRow

Reimplemented from GridHandler.

Definition at line 224 of file MarketsGridHandler.inc.php.

References getSubmission().

Referenced by updateMarket().

◆ getSubmission()

MarketsGridHandler::getSubmission ( )

Get the submission associated with this grid.

Returns
Submission

Definition at line 64 of file MarketsGridHandler.inc.php.

References $_submission.

Referenced by editMarket(), getRequestArgs(), getRowInstance(), and updateMarket().

◆ initialize()

◆ loadData()

MarketsGridHandler::loadData (   $request,
  $filter = null 
)

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 244 of file MarketsGridHandler.inc.php.

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

◆ setPublication()

MarketsGridHandler::setPublication (   $publication)

Set the Publication

Parameters
Publication

Definition at line 88 of file MarketsGridHandler.inc.php.

Referenced by initialize().

◆ setPublicationFormat()

MarketsGridHandler::setPublicationFormat (   $publicationFormat)

Set the publication format

Parameters
PublicationFormat

Definition at line 104 of file MarketsGridHandler.inc.php.

Referenced by initialize().

◆ setSubmission()

MarketsGridHandler::setSubmission (   $submission)

Set the Submission

Parameters
Submission

Definition at line 72 of file MarketsGridHandler.inc.php.

Referenced by initialize().

◆ updateMarket()

MarketsGridHandler::updateMarket (   $args,
  $request 
)

Update a markets entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 292 of file MarketsGridHandler.inc.php.

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

Field Documentation

◆ $_publication

Publication MarketsGridHandler::$_publication

Definition at line 37 of file MarketsGridHandler.inc.php.

Referenced by getPublication().

◆ $_publicationFormat

PublicationFormat MarketsGridHandler::$_publicationFormat

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

Referenced by getPublicationFormat().

◆ $_submission

Submission MarketsGridHandler::$_submission

Definition at line 31 of file MarketsGridHandler.inc.php.

Referenced by getSubmission().


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