Open Journal Systems  3.3.0
SetupListbuilderHandler Class Reference
Inheritance diagram for SetupListbuilderHandler:
ListbuilderHandler GridHandler PKPHandler ReviewFormElementResponseItemListbuilderHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 getContext ()
 
 initialize ($request, $args=null)
 
 setContext ($context)
 
- Public Member Functions inherited from ListbuilderHandler
 canAddItems ()
 
 deleteEntry ($request, $rowId)
 
 fetch ($args, $request)
 
 fetchOptions ($args, $request)
 
 getAddItemLinkAction ($actionRequest)
 
 getNewRowId ($request)
 
 getOptions ($request)
 
 getSaveFieldName ()
 
 getSaveType ()
 
 getSourceType ()
 
 getTemplate ()
 
 insertEntry ($request, $newRowId)
 
 save ($args, $request)
 
 setSaveFieldName ($fieldName)
 
 setSaveType ($saveType)
 
 setSourceType ($sourceType)
 
 updateEntry ($request, $rowId, $newRowId)
 
- 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 ()
 
 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

 $_context
 
- Data Fields inherited from ListbuilderHandler
 $_saveFieldName = null
 
 $_saveType = LISTBUILDER_SAVE_TYPE_INTERNAL
 
 $_sourceType
 
- 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 ListbuilderHandler
static unpack ($request, $data, $deletionCallback, $insertionCallback, $updateCallback)
 
- 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 ListbuilderHandler
 getRowInstance ()
 
- 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

Base class for setup listbuilders.

Definition at line 18 of file SetupListbuilderHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SetupListbuilderHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 28 of file SetupListbuilderHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

SetupListbuilderHandler::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 55 of file SetupListbuilderHandler.inc.php.

References PKPHandler\addPolicy().

◆ getContext()

SetupListbuilderHandler::getContext ( )

Get the current context

Returns
Context

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

References $_context.

◆ initialize()

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

See also
PKPHandler::initialize()
Parameters
$requestPKPRequest
$argsarray optional

Reimplemented from ListbuilderHandler.

Reimplemented in ReviewFormElementResponseItemListbuilderHandler.

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

References setContext().

◆ setContext()

SetupListbuilderHandler::setContext (   $context)

Set the current context

Parameters
$contextContext

Definition at line 40 of file SetupListbuilderHandler.inc.php.

Referenced by initialize().

Field Documentation

◆ $_context

Context SetupListbuilderHandler::$_context

Definition at line 23 of file SetupListbuilderHandler.inc.php.

Referenced by getContext().


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