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

Public Member Functions

 __construct ()
 
 addStaticPage ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 delete ($args, $request)
 
 editStaticPage ($args, $request)
 
 getRowInstance ()
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 updateStaticPage ($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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Static Public Member Functions

static setPlugin ($plugin)
 
- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 

Static Public Attributes

static $plugin
 

Additional Inherited Members

- 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 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 static pages grid requests.

Definition at line 20 of file StaticPageGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

StaticPageGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addStaticPage()

StaticPageGridHandler::addStaticPage (   $args,
  $request 
)

An action to add a new custom static page

Parameters
$argsarray Arguments to the request
$requestPKPRequest Request object

Definition at line 138 of file StaticPageGridHandler.inc.php.

References editStaticPage().

◆ authorize()

StaticPageGridHandler::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 53 of file StaticPageGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ delete()

StaticPageGridHandler::delete (   $args,
  $request 
)

Delete a static page

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 197 of file StaticPageGridHandler.inc.php.

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

◆ editStaticPage()

StaticPageGridHandler::editStaticPage (   $args,
  $request 
)

An action to edit a static page

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

Definition at line 150 of file StaticPageGridHandler.inc.php.

References $plugin, and PKPHandler\setupTemplate().

Referenced by addStaticPage().

◆ getRowInstance()

StaticPageGridHandler::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 114 of file StaticPageGridHandler.inc.php.

◆ index()

StaticPageGridHandler::index (   $args,
  $request 
)

Display the grid's containing page.

Parameters
$argsarray
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 126 of file StaticPageGridHandler.inc.php.

◆ initialize()

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

◆ setPlugin()

static StaticPageGridHandler::setPlugin (   $plugin)
static

Set the static pages plugin.

Parameters
$pluginStaticPagesPlugin

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

References $plugin.

Referenced by StaticPagesPlugin\setupGridHandler().

◆ updateStaticPage()

StaticPageGridHandler::updateStaticPage (   $args,
  $request 
)

Update a custom block

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 169 of file StaticPageGridHandler.inc.php.

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

Field Documentation

◆ $plugin

StaticPagesPlugin StaticPageGridHandler::$plugin
static

The static pages plugin

Definition at line 25 of file StaticPageGridHandler.inc.php.

Referenced by editStaticPage(), setPlugin(), and updateStaticPage().


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