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

Public Member Functions

 _getPluginName ()
 
 authorize ($request, &$args, $roleAssignments)
 
 ExportableUsersGridHandler ()
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRequestArgs ()
 
 getSelectName ()
 
 initFeatures ($request, $args)
 
 initialize ($request)
 
 isDataElementSelected ($gridDataElement)
 
 loadData ($request, $filter)
 
 renderFilter ($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()
 
 $_data
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_instructions = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_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

Handle exportable user grid requests.

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

Member Function Documentation

ExportableUsersGridHandler::_getPluginName ( )

Fetch the name of the plugin for this grid's calling context.

Returns
string

Definition at line 265 of file ExportableUsersGridHandler.inc.php.

Referenced by getRequestArgs().

ExportableUsersGridHandler::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 42 of file ExportableUsersGridHandler.inc.php.

References PKPHandler\addPolicy().

ExportableUsersGridHandler::ExportableUsersGridHandler ( )

Constructor

Definition at line 27 of file ExportableUsersGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

ExportableUsersGridHandler::getFilterForm ( )

Returns a Form object or the path name of a filter template.

Returns
Form|string
string Filter template.

Definition at line 250 of file ExportableUsersGridHandler.inc.php.

ExportableUsersGridHandler::getFilterSelectionData (   $request)

Method that extracts the user's filter selection from the request either by instantiating the filter's Form object or by reading the request directly (if using a simple filter template only).

Parameters
$requestPKPRequest
Returns
array
array Filter selection data.

Definition at line 231 of file ExportableUsersGridHandler.inc.php.

ExportableUsersGridHandler::getRequestArgs ( )
ExportableUsersGridHandler::getSelectName ( )

Get the select parameter name to store the selected files.

Returns
string

Definition at line 155 of file ExportableUsersGridHandler.inc.php.

ExportableUsersGridHandler::initFeatures (   $request,
  $args 
)

Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.

Parameters
$requestRequest
$argsarray
Returns
array Array with initialized grid features objects.

Definition at line 146 of file ExportableUsersGridHandler.inc.php.

ExportableUsersGridHandler::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 51 of file ExportableUsersGridHandler.inc.php.

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

ExportableUsersGridHandler::isDataElementSelected (   $gridDataElement)

Returns the current selection state of the grid data element.

Parameters
$gridDataElementmixed
Returns
boolean

Definition at line 165 of file ExportableUsersGridHandler.inc.php.

ExportableUsersGridHandler::loadData (   $request,
  $filter 
)

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 174 of file ExportableUsersGridHandler.inc.php.

References DAORegistry\getDAO(), GridHandler\getGridRangeInfo(), and PKPHandler\getId().

ExportableUsersGridHandler::renderFilter (   $request)

Render the filter (a template or a Form).

Parameters
$requestPKPRequest
$filterDataArray Data to be used by the filter template.
Returns
string

Definition at line 195 of file ExportableUsersGridHandler.inc.php.

References DAORegistry\getDAO().


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