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

Public Member Functions

 __construct ()
 
 _getPluginName ()
 
 authorize ($request, &$args, $roleAssignments)
 
 getFilterSelectionData ($request)
 
 getRequestArgs ()
 
 getSelectName ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 isDataElementSelected ($gridDataElement)
 
 renderFilter ($request, $filterData=array())
 
- 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)
 
 getRequestedRow ($request, $args)
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 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

 $_pluginName
 
- 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

 getFilterForm ()
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 getRowInstance ()
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 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())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle exportable user grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

ExportableUsersGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getPluginName()

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.

References $_pluginName.

Referenced by getRequestArgs().

◆ authorize()

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.
Returns
boolean

Reimplemented from GridHandler.

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

References PKPHandler\addPolicy().

◆ getFilterForm()

ExportableUsersGridHandler::getFilterForm ( )
protected

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

Returns
Form|string
string Filter template.

Reimplemented from GridHandler.

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

◆ getFilterSelectionData()

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.

Reimplemented from GridHandler.

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

◆ getRequestArgs()

ExportableUsersGridHandler::getRequestArgs ( )
See also
GridHandler::getRequestArgs()

Reimplemented from GridHandler.

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

References _getPluginName().

◆ getSelectName()

ExportableUsersGridHandler::getSelectName ( )

Get the select parameter name to store the selected files.

Returns
string

Reimplemented from GridHandler.

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

◆ initFeatures()

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
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

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

◆ initialize()

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

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

Reimplemented from GridHandler.

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

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

◆ isDataElementSelected()

ExportableUsersGridHandler::isDataElementSelected (   $gridDataElement)

Returns the current selection state of the grid data element.

Parameters
$gridDataElementmixed
Returns
boolean

Reimplemented from GridHandler.

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

◆ loadData()

ExportableUsersGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$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.

Reimplemented from GridHandler.

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

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

◆ renderFilter()

ExportableUsersGridHandler::renderFilter (   $request,
  $filterData = array() 
)

Render the filter (a template).

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

Reimplemented from GridHandler.

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

References DAORegistry\getDAO().

Field Documentation

◆ $_pluginName

ExportableUsersGridHandler::$_pluginName

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

Referenced by _getPluginName().


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