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

Public Member Functions

 __construct ()
 
 addUserGroup ($args, $request)
 
 assignStage ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 editUserGroup ($args, $request)
 
 getFilterSelectionData ($request)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 removeUserGroup ($args, $request)
 
 renderFilter ($request, $filterData=array())
 
 unassignStage ($args, $request)
 
 updateUserGroup ($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 ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 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)
 

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())
 
- 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 Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle operations for user group management operations.

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

Constructor & Destructor Documentation

◆ __construct()

UserGroupGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addUserGroup()

UserGroupGridHandler::addUserGroup (   $args,
  $request 
)

Handle the add user group operation.

Parameters
$argsarray
$requestPKPRequest

Definition at line 259 of file UserGroupGridHandler.inc.php.

References editUserGroup().

◆ assignStage()

UserGroupGridHandler::assignStage (   $args,
  $request 
)

Assign stage to user group.

Parameters
$argsarray
$requestPKPRequest

Definition at line 349 of file UserGroupGridHandler.inc.php.

◆ authorize()

UserGroupGridHandler::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 67 of file UserGroupGridHandler.inc.php.

References PKPHandler\addPolicy(), fatalError(), and DAORegistry\getDAO().

◆ editUserGroup()

UserGroupGridHandler::editUserGroup (   $args,
  $request 
)

Handle the edit user group operation.

Parameters
$argsarray
Returns
JSONMessage JSON object

Definition at line 268 of file UserGroupGridHandler.inc.php.

Referenced by addUserGroup().

◆ getFilterForm()

UserGroupGridHandler::getFilterForm ( )
protected
See also
GridHandler::getFilterForm()
Returns
string Filter template.

Reimplemented from GridHandler.

Definition at line 238 of file UserGroupGridHandler.inc.php.

◆ getFilterSelectionData()

UserGroupGridHandler::getFilterSelectionData (   $request)
See also
GridHandler::getFilterSelectionData()
Returns
array Filter selection data.

Reimplemented from GridHandler.

Definition at line 223 of file UserGroupGridHandler.inc.php.

◆ getRowInstance()

UserGroupGridHandler::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
UserGroupGridRow

Reimplemented from GridHandler.

Definition at line 193 of file UserGroupGridHandler.inc.php.

◆ initFeatures()

UserGroupGridHandler::initFeatures (   $request,
  $args 
)
See also
GridHandler::initFeatures()

Reimplemented from GridHandler.

Definition at line 245 of file UserGroupGridHandler.inc.php.

◆ initialize()

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

◆ loadData()

UserGroupGridHandler::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

Reimplemented from GridHandler.

Definition at line 159 of file UserGroupGridHandler.inc.php.

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

◆ removeUserGroup()

UserGroupGridHandler::removeUserGroup (   $args,
  $request 
)

Remove user group.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 304 of file UserGroupGridHandler.inc.php.

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

◆ renderFilter()

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

◆ unassignStage()

UserGroupGridHandler::unassignStage (   $args,
  $request 
)

Unassign stage to user group.

Parameters
$argsarray
$requestPKPRequest

Definition at line 358 of file UserGroupGridHandler.inc.php.

◆ updateUserGroup()

UserGroupGridHandler::updateUserGroup (   $args,
  $request 
)

Update user group data on database and grid.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 282 of file UserGroupGridHandler.inc.php.

References DAO\getDataChangedEvent().


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