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

Public Member Functions

 __construct ()
 
 addCustomBlock ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteCustomBlock ($args, $request)
 
 editCustomBlock ($args, $request)
 
 getRowInstance ()
 
 initialize ($request, $args=null)
 
 updateCustomBlock ($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)
 
 getRequestArgs ()
 
 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

 $plugin
 
- 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 ()
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle custom block manager grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

CustomBlockGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 29 of file CustomBlockGridHandler.inc.php.

References PKPHandler\addRoleAssignment(), and PluginRegistry\getPlugin().

Member Function Documentation

◆ addCustomBlock()

CustomBlockGridHandler::addCustomBlock (   $args,
  $request 
)

An action to add a new custom block

Parameters
$argsarray Arguments to the request
$requestPKPRequest Request object

Definition at line 125 of file CustomBlockGridHandler.inc.php.

References editCustomBlock().

◆ authorize()

CustomBlockGridHandler::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 45 of file CustomBlockGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteCustomBlock()

CustomBlockGridHandler::deleteCustomBlock (   $args,
  $request 
)

Delete a custom block

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 204 of file CustomBlockGridHandler.inc.php.

References $plugin, DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ editCustomBlock()

CustomBlockGridHandler::editCustomBlock (   $args,
  $request 
)

An action to edit a custom block

Parameters
$argsarray Arguments to the request
$requestPKPRequest Request object
Returns
string Serialized JSON object

Definition at line 137 of file CustomBlockGridHandler.inc.php.

References $plugin, and PKPHandler\setupTemplate().

Referenced by addCustomBlock().

◆ getRowInstance()

CustomBlockGridHandler::getRowInstance ( )

Get a new instance of a grid row. May be overridden by subclasses if they want to provide a custom row definition.

Returns
GridRow

Reimplemented from GridHandler.

Definition at line 113 of file CustomBlockGridHandler.inc.php.

◆ initialize()

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

◆ updateCustomBlock()

CustomBlockGridHandler::updateCustomBlock (   $args,
  $request 
)

Update a custom block

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

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

References $plugin, DAO\getDataChangedEvent(), and PKPHandler\setupTemplate().

Field Documentation

◆ $plugin

CustomBlockManagerPlugin CustomBlockGridHandler::$plugin

The custom block manager plugin

Definition at line 24 of file CustomBlockGridHandler.inc.php.

Referenced by deleteCustomBlock(), editCustomBlock(), initialize(), and updateCustomBlock().


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