Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ContextGridHandler Class Reference
Inheritance diagram for ContextGridHandler:
GridHandler PKPHandler PressGridHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 ContextGridHandler ()
 
 createContext ($args, $request)
 
 getDataElementSequence ($context)
 
 getPublishChangeEvents ()
 
 getRowInstance ()
 
 initFeatures ($request, $args)
 
 initialize ($request)
 
 loadData ($request)
 
 setDataElementSequence ($request, $rowId, $context, $newSequence)
 
- 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)
 

Protected Member Functions

 _getRedirectEvent ($request, $newContextPath, $openWizard)
 
- 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 ()
 

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()
 
 $_data
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_instructions = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

Handle context grid requests.

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

Member Function Documentation

ContextGridHandler::_getRedirectEvent (   $request,
  $newContextPath,
  $openWizard 
)
protected

Return a redirect event.

Parameters
$requestRequest
$newContextPathstring
$openWizardboolean

Definition at line 194 of file ContextGridHandler.inc.php.

Referenced by PressGridHandler\updateContext().

ContextGridHandler::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.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

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

References PKPHandler\addPolicy().

ContextGridHandler::ContextGridHandler ( )

Constructor

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

References PKPHandler\addRoleAssignment().

ContextGridHandler::createContext (   $args,
  $request 
)

Add a new context.

Parameters
$argsarray
$requestPKPRequest

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

ContextGridHandler::getDataElementSequence (   $context)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Definition at line 149 of file ContextGridHandler.inc.php.

ContextGridHandler::getPublishChangeEvents ( )

Get the list of "publish data changed" events. Used to update the site context switcher upon create/delete.

Returns
array

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

ContextGridHandler::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
UserGridRow

Definition at line 120 of file ContextGridHandler.inc.php.

ContextGridHandler::initFeatures (   $request,
  $args 
)

Definition at line 156 of file ContextGridHandler.inc.php.

ContextGridHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters
$requestPKPRequest
$argsarray

Definition at line 55 of file ContextGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), and AppLocale\requireComponents().

ContextGridHandler::loadData (   $request)

Implement this method to load data into the grid.

Parameters
$requestRequest
$filterarray An associative array with filter data as returned by getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
grid data
Parameters
$requestPKPRequest
Returns
array Grid data.

Definition at line 129 of file ContextGridHandler.inc.php.

References Application\getContextDAO().

ContextGridHandler::setDataElementSequence (   $request,
  $rowId,
  $context,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Definition at line 140 of file ContextGridHandler.inc.php.

References Application\getContextDAO().


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