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

Public Member Functions

 _getAssignedStages ($contextId, $userGroupId)
 
 _getContextId ()
 
 _getUserGroupForm ($request)
 
 addUserGroup ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 editUserGroup ($args, $request)
 
 getCategoryData (&$stage)
 
 getCategoryRowInstance ()
 
 getRowInstance ()
 
 initialize ($request)
 
 loadData ($request, $filter)
 
 updateUserGroup ($args, $request)
 
 UserGroupGridHandler ()
 
- Public Member Functions inherited from CategoryGridHandler
 CategoryGridHandler ($dataProvider=null)
 
 fetchCategory (&$args, $request)
 
 getCurrentCategoryId ()
 
 getDataElementInCategorySequence ($categoryId, &$gridDataElement)
 
 getEmptyCategoryRowText ()
 
 getJSHandler ()
 
 getRequestArgs ()
 
 hasGridDataElementsInCategory ($categoryDataElement, $request)
 
 isDataElementInCategorySelected ($categoryId, &$gridDataElement)
 
 setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence)
 
 setEmptyCategoryRowText ($translationKey)
 
 setUrls ($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 CategoryGridHandler
 $_currentCategoryId = null
 
 $_emptyCategoryRowText = 'grid.noItems'
 
- 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 CategoryGridHandler
 doSpecificFetchGridActions ($args, $request, &$templateMgr)
 
getCategoryData (&$categoryDataElement, $filter=null)
 
 getCategoryRowIdParameterName ()
 
 getCategoryRowInstance ()
 
 getRequestedCategoryRow ($request, $args)
 
 getRowDataElement ($request, $rowId)
 
 getRowsSequence ($request)
 
 renderRowInternally ($request, $row)
 
 setFirstDataColumn ()
 
- 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 operations for user group management operations.

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

Member Function Documentation

UserGroupGridHandler::_getAssignedStages (   $contextId,
  $userGroupId 
)

Get a list of stages that are assigned to a user group.

Parameters
$idint Context id
$idint UserGroup id
Returns
array Given user group stages assignments.

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

References DAORegistry\getDAO().

Referenced by loadData().

UserGroupGridHandler::_getContextId ( )

Get context id.

Returns
int

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

Referenced by _getUserGroupForm(), getCategoryData(), and loadData().

UserGroupGridHandler::_getUserGroupForm (   $request)

Get a UserGroupForm instance.

Parameters
$requestRequest
Returns
UserGroupForm

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

References _getContextId().

Referenced by editUserGroup(), and updateUserGroup().

UserGroupGridHandler::addUserGroup (   $args,
  $request 
)

Handle the add user group operation.

Parameters
$argsarray
$requestPKPRequest

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

References editUserGroup().

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

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

References PKPHandler\addPolicy().

UserGroupGridHandler::editUserGroup (   $args,
  $request 
)

Handle the edit user group operation.

Parameters
$argsarray
$requestPKPRequest

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

References _getUserGroupForm(), and JSONMessage\getString().

Referenced by addUserGroup().

UserGroupGridHandler::getCategoryData ( $stage)

Fetch the contents of a category.

Parameters
$categoryDataElementmixed
Returns
array

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

References _getContextId(), and DAORegistry\getDAO().

UserGroupGridHandler::getCategoryRowInstance ( )

Returns
UserGroupGridCategoryRow

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

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

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

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

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

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

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

References _getAssignedStages(), _getContextId(), and DAORegistry\getDAO().

UserGroupGridHandler::updateUserGroup (   $args,
  $request 
)

Update user group data on database and grid.

Parameters
$argsarray
$requestPKPRequest

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

References _getUserGroupForm(), DAO\getDataChangedEvent(), and JSONMessage\getString().

UserGroupGridHandler::UserGroupGridHandler ( )

Constructor

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

References PKPHandler\addRoleAssignment().


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