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

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 getAddItemLinkAction ($actionRequest)
 
getContext ()
 
 getOptions ($includeDesignations=false)
 
 getRequestArgs ()
 
 getRowDataElement ($request, $rowId)
 
 getUserId ()
 
 initialize ($request)
 
 loadData ()
 
 setContext (&$context)
 
 setUserId ($userId)
 
 UserUserGroupListbuilderHandler ()
 
- Public Member Functions inherited from ListbuilderHandler
 deleteEntry ($request, $rowId)
 
 fetch ($args, $request)
 
 fetchOptions ($args, $request)
 
 getAddItemLinkAction ($actionRequest)
 
 getNewRowId ($request)
 
 getOptions ($request)
 
 getSaveFieldName ()
 
 getSaveType ()
 
 getSourceType ()
 
 getTemplate ()
 
 initialize ($request, $addItemLink=true)
 
 insertEntry ($request, $newRowId)
 
 ListbuilderHandler ()
 
 save ($args, $request)
 
 setSaveFieldName ($fieldName)
 
 setSaveType ($saveType)
 
 setSourceType ($sourceType)
 
 unpack ($request, $data, $deletionCallback=null, $insertionCallback=null, $updateCallback=null)
 
 updateEntry ($request, $rowId, $newRowId)
 
- 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)
 

Public Attributes

 $_userId
 
- Public Attributes inherited from ListbuilderHandler
 $_saveFieldName = null
 
 $_saveType = LISTBUILDER_SAVE_TYPE_INTERNAL
 
 $_sourceType
 
- 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()
 

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 Member Functions inherited from ListbuilderHandler
 getRowInstance ()
 
- 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

Class assign/remove mappings of user user groups.

Definition at line 18 of file UserUserGroupListbuilderHandler.inc.php.

Member Function Documentation

UserUserGroupListbuilderHandler::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 162 of file UserUserGroupListbuilderHandler.inc.php.

References AppLocale\requireComponents().

UserUserGroupListbuilderHandler::getAddItemLinkAction (   $actionRequest)

Get the "add item" link action.

Parameters
$actionRequestActionRequest
Returns
LinkAction

Definition at line 98 of file UserUserGroupListbuilderHandler.inc.php.

& UserUserGroupListbuilderHandler::getContext ( )

Get the context

Returns
Context

Definition at line 78 of file UserUserGroupListbuilderHandler.inc.php.

References getUserId().

UserUserGroupListbuilderHandler::getOptions (   $includeDesignations = false)

Fetch the options for a LISTBUILDER_SOURCE_TYPE_SELECT LB Should return a multidimensional array: array( array('column 1 option 1', 'column 2 option 1'), array('column 1 option 2', 'column 2 option 2' );

Parameters
requestRequest
Returns
array
Parameters
$includeDesignationsboolean

Definition at line 113 of file UserUserGroupListbuilderHandler.inc.php.

UserUserGroupListbuilderHandler::getRequestArgs ( )

Get an array with all request parameters necessary to uniquely identify the data selection of this data provider.

Returns
array

Definition at line 89 of file UserUserGroupListbuilderHandler.inc.php.

UserUserGroupListbuilderHandler::getRowDataElement (   $request,
  $rowId 
)

Retrieve a single data element from the grid's data source corresponding to the given row id. If none is found then return null.

Parameters
$rowId
Returns
mixed

Definition at line 211 of file UserUserGroupListbuilderHandler.inc.php.

UserUserGroupListbuilderHandler::getUserId ( )

Get the user id

Returns
integer

Definition at line 60 of file UserUserGroupListbuilderHandler.inc.php.

Referenced by getContext().

UserUserGroupListbuilderHandler::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 172 of file UserUserGroupListbuilderHandler.inc.php.

UserUserGroupListbuilderHandler::loadData ( )

Initialize the grid with the currently selected set of user groups.

Definition at line 149 of file UserUserGroupListbuilderHandler.inc.php.

References PKPHandler\addPolicy().

UserUserGroupListbuilderHandler::setContext ( $context)

Set the context

Parameters
$contextContext

Definition at line 69 of file UserUserGroupListbuilderHandler.inc.php.

UserUserGroupListbuilderHandler::setUserId (   $userId)

Set the user id

Parameters
$userIdinteger

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

UserUserGroupListbuilderHandler::UserUserGroupListbuilderHandler ( )

Constructor

Definition at line 35 of file UserUserGroupListbuilderHandler.inc.php.

Member Data Documentation

integer UserUserGroupListbuilderHandler::$_userId

the user id for which to map user groups

Definition at line 23 of file UserUserGroupListbuilderHandler.inc.php.


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