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

Public Member Functions

 __construct ()
 
 addSpotlight ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteSpotlight ($args, $request)
 
 editSpotlight ($args, $request)
 
getPress ()
 
 getRequestArgs ()
 
 getRowInstance ()
 
 initialize ($request, $args=null)
 
 itemAutocomplete ($args, $request)
 
 loadData ($request, $filter=null)
 
 setPress ($press)
 
 updateSpotlight ($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

 $_press
 
- 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

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

Constructor & Destructor Documentation

◆ __construct()

ManageSpotlightsGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addSpotlight()

ManageSpotlightsGridHandler::addSpotlight (   $args,
  $request 
)

Definition at line 202 of file ManageSpotlightsGridHandler.inc.php.

References editSpotlight().

◆ authorize()

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

Reimplemented from GridHandler.

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

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

◆ deleteSpotlight()

ManageSpotlightsGridHandler::deleteSpotlight (   $args,
  $request 
)

Delete a spotlight entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 281 of file ManageSpotlightsGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), and getPress().

◆ editSpotlight()

ManageSpotlightsGridHandler::editSpotlight (   $args,
  $request 
)

Edit a spotlight entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 212 of file ManageSpotlightsGridHandler.inc.php.

Referenced by addSpotlight().

◆ getPress()

& ManageSpotlightsGridHandler::getPress ( )

Get the press associated with this grid.

Returns
Press

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

References $_press.

Referenced by deleteSpotlight(), getRequestArgs(), getRowInstance(), itemAutocomplete(), loadData(), and updateSpotlight().

◆ getRequestArgs()

ManageSpotlightsGridHandler::getRequestArgs ( )

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

Returns
array

Reimplemented from GridHandler.

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

References getPress().

◆ getRowInstance()

ManageSpotlightsGridHandler::getRowInstance ( )
See also
GridHandler::getRowInstance()
Returns
SpotlightsGridRow

Reimplemented from GridHandler.

Definition at line 172 of file ManageSpotlightsGridHandler.inc.php.

References getPress().

Referenced by updateSpotlight().

◆ initialize()

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

◆ itemAutocomplete()

ManageSpotlightsGridHandler::itemAutocomplete (   $args,
  $request 
)

Returns a JSON list for the autocomplete field. Fetches a list of possible spotlight options based on the spotlight type chosen.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 311 of file ManageSpotlightsGridHandler.inc.php.

References PKPServices\get(), DAORegistry\getDAO(), getPress(), GridHandler\noAutocompleteResults(), and PKPString\strtoupper().

◆ loadData()

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

Reimplemented from GridHandler.

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

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

◆ setPress()

ManageSpotlightsGridHandler::setPress (   $press)

Set the Press (authorized)

Parameters
Press

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

Referenced by initialize().

◆ updateSpotlight()

ManageSpotlightsGridHandler::updateSpotlight (   $args,
  $request 
)

Update a spotlight entry

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 229 of file ManageSpotlightsGridHandler.inc.php.

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

Field Documentation

◆ $_press

Press ManageSpotlightsGridHandler::$_press

Definition at line 39 of file ManageSpotlightsGridHandler.inc.php.

Referenced by getPress().


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