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

Public Member Functions

 __construct ()
 
 addUser ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 disableUser ($args, $request)
 
 editDisableUser ($args, $request)
 
 editEmail ($args, $request)
 
 editUser ($args, $request)
 
 getFilterSelectionData ($request)
 
 getJSHandler ()
 
 getRequestArgs ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 mergeUsers ($args, $request)
 
 removeUser ($args, $request)
 
 renderFilter ($request, $filterData=array())
 
 sendEmail ($args, $request)
 
 updateUser ($args, $request)
 
 updateUserRoles ($args, $request)
 
- 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 ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 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

 $_oldUserId
 
- 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 ()
 
 getRowInstance ()
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 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 user grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

UserGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 29 of file UserGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addUser()

UserGridHandler::addUser (   $args,
  $request 
)

Add a new user.

Parameters
$argsarray
$requestPKPRequest

Definition at line 262 of file UserGridHandler.inc.php.

References editUser().

◆ authorize()

UserGridHandler::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 46 of file UserGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ disableUser()

UserGridHandler::disableUser (   $args,
  $request 
)

Enable/Disable an existing user

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 404 of file UserGridHandler.inc.php.

References Validation\canAdminister(), and DAO\getDataChangedEvent().

◆ editDisableUser()

UserGridHandler::editDisableUser (   $args,
  $request 
)

Edit enable/disable user form

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 374 of file UserGridHandler.inc.php.

References Validation\canAdminister().

◆ editEmail()

UserGridHandler::editEmail (   $args,
  $request 
)

Displays a modal to edit an email message to the user.

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 474 of file UserGridHandler.inc.php.

References DAORegistry\getDAO().

◆ editUser()

UserGridHandler::editUser (   $args,
  $request 
)

Edit an existing user.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 273 of file UserGridHandler.inc.php.

References Validation\canAdminister().

Referenced by addUser().

◆ getFilterForm()

UserGridHandler::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 241 of file UserGridHandler.inc.php.

◆ getFilterSelectionData()

UserGridHandler::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 220 of file UserGridHandler.inc.php.

◆ getJSHandler()

UserGridHandler::getJSHandler ( )

Get the js handler for this component.

Returns
string

Reimplemented from GridHandler.

Definition at line 249 of file UserGridHandler.inc.php.

◆ getRequestArgs()

UserGridHandler::getRequestArgs ( )
See also
GridHandler::getRequestArgs()

Reimplemented from GridHandler.

Definition at line 573 of file UserGridHandler.inc.php.

References $_oldUserId.

◆ getRowInstance()

UserGridHandler::getRowInstance ( )
protected

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

Reimplemented from GridHandler.

Definition at line 144 of file UserGridHandler.inc.php.

◆ initFeatures()

UserGridHandler::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 151 of file UserGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from GridHandler.

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

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

◆ loadData()

UserGridHandler::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 161 of file UserGridHandler.inc.php.

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

◆ mergeUsers()

UserGridHandler::mergeUsers (   $args,
  $request 
)

Allow user account merging, including attributed submissions etc.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 542 of file UserGridHandler.inc.php.

References Validation\canAdminister().

◆ removeUser()

UserGridHandler::removeUser (   $args,
  $request 
)

Remove all user group assignments for a context for a given user.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 442 of file UserGridHandler.inc.php.

References Validation\canAdminister(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ renderFilter()

UserGridHandler::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 182 of file UserGridHandler.inc.php.

References DAORegistry\getDAO().

◆ sendEmail()

UserGridHandler::sendEmail (   $args,
  $request 
)

Send the user email and close the modal.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 506 of file UserGridHandler.inc.php.

References DAORegistry\getDAO().

◆ updateUser()

UserGridHandler::updateUser (   $args,
  $request 
)

Update an existing user.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 297 of file UserGridHandler.inc.php.

References Validation\canAdminister(), and DAO\getDataChangedEvent().

◆ updateUserRoles()

UserGridHandler::updateUserRoles (   $args,
  $request 
)

Update a newly created user's roles

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 342 of file UserGridHandler.inc.php.

References Validation\canAdminister(), and DAO\getDataChangedEvent().

Field Documentation

◆ $_oldUserId

UserGridHandler::$_oldUserId

integer user id for the user to remove

Definition at line 24 of file UserGridHandler.inc.php.

Referenced by getRequestArgs().


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