Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SetupGridHandler Class Reference
Inheritance diagram for SetupGridHandler:
GridHandler PKPHandler ContributorGridHandler GenreGridHandler SeriesGridHandler SponsorGridHandler SubmissionChecklistGridHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments, $contextRequired=true)
 initialize ($request)
 SetupGridHandler ()
 uploadImage ($args, $request)
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 addColumn ($column)
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 fetchCell (&$args, $request)
 fetchGrid ($args, $request)
 fetchRow (&$args, $request)
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 getColumn ($columnId)
getColumns ()
getColumnsByFlag ($flag)
 getColumnsCount ($flag)
 getDataElementSequence (&$gridDataElement)
 getDataProvider ()
 getEmptyRowText ()
 getFeatures ()
 getFootNote ()
getGridDataElements ($request)
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 getInstructions ()
 getIsSubcomponent ()
 getItemIterator ()
 getJSHandler ()
 getPublishChangeEvents ()
 getRequestArg ($key)
 getRequestArgs ()
 getRequestedRow ($request, $args)
 getSelectName ()
 getTemplate ()
 getTitle ()
 getUrls ()
 GridHandler ($dataProvider=null)
 hasColumn ($columnId)
 hasGridDataElements ($request)
 initialize ($request, $args=null)
 isDataElementSelected ($gridDataElement)
 renderRow ($request, $row)
 saveSequence ($args, $request)
 setDataElementSequence ($request, $rowId, &$gridDataElement, $newSequence)
 setEmptyRowText ($emptyRowText)
 setFootNote ($footNote)
 setGridDataElements ($data)
 setInstructions ($instructions)
 setTemplate ($template)
 setTitle ($title)
 setUrls ($request, $extraUrls=array())
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 addPolicy ($authorizationPolicy, $addToTop=false)
 addRoleAssignment ($roleIds, $operations)
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
getAuthorizedContext ()
getAuthorizedContextObject ($assocType)
getDispatcher ()
 getFirstUserContext ($user, $contexts)
 getId ()
 getLastAuthorizationMessage ()
 getLoginExemptions ()
 getRoleAssignment ($roleId)
 getRoleAssignments ()
 getWorkingContexts ($request)
 index ($args, $request)
 initialize ($request, $args=null)
 PKPHandler ()
 setDispatcher ($dispatcher)
 setId ($id)
 setupTemplate ($request)
 validate ($requiredContexts=null, $request=null)

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
static getRangeInfo ($request, $rangeName, $contextData=null)
static hashPageContext ($request, $contextData=array())
- Public Attributes inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 $_columns = array()
 $_emptyRowText = 'grid.noItems'
 $_footNote = ''
 $_instructions = ''
 $_title = ''
- Public Attributes inherited from PKPHandler
 $_checks = array()
 $_roleAssignments = array()
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 doSpecificFetchGridActions ($args, $request, $templateMgr)
getDataElementFromRequest ($request, &$elementId)
 getFilterForm ()
 getFilterSelectionData ($request)
 getRowDataElement ($request, $rowId)
 getRowInstance ()
 getRowsSequence ($request)
 initFeatures ($request, &$args)
 loadData ($request, $filter)
 noAutocompleteResults ()
 renderFilter ($request, $filterData=array())
 renderGridBodyPartsInternally ($request)
 renderRowInternally ($request, $row)
 renderRowsInternally ($request, &$elements)
 setFirstDataColumn ()

Detailed Description

Base class for setup grid handlers.

Definition at line 18 of file

Member Function Documentation

SetupGridHandler::authorize (   $request,
  $contextRequired = true 

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.

$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced

Definition at line 43 of file

References PKPHandler\addPolicy().

SetupGridHandler::initialize (   $request)

See Also
$argsarray optional

Definition at line 33 of file

References AppLocale\requireComponents().

SetupGridHandler::SetupGridHandler ( )


Definition at line 22 of file

References PKPHandler\addRoleAssignment().

SetupGridHandler::uploadImage (   $args,

Handle file uploads for cover/image art for things like Series and Categories.


Definition at line 56 of file

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