Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
UserGroupForm Class Reference
Inheritance diagram for UserGroupForm:
Form

Public Member Functions

 _assignStagesToUserGroup ($userGroupId, $userAssignedStages)
 
 _setUserGroupLocaleFields ($userGroup, $request)
 
 execute ($request)
 
 fetch ($request)
 
 getContextId ()
 
 getLocaleFieldNames ()
 
 getPermitSelfRegistrationRoles ()
 
 getUserGroupId ()
 
 initData ()
 
 readInputData ()
 
 UserGroupForm ($contextId, $userGroupId=null)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Public Attributes

 $_contextId
 
 $_userGroupId
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form to add/edit user group.

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

Member Function Documentation

UserGroupForm::_assignStagesToUserGroup (   $userGroupId,
  $userAssignedStages 
)

Setup the stages assignments to a user group in database.

Parameters
$userGroupIdint User group id that will receive the stages.
$userAssignedStagesarray of stages currently assigned to a user.

Definition at line 186 of file UserGroupForm.inc.php.

UserGroupForm::_setUserGroupLocaleFields (   $userGroup,
  $request 
)

Set locale fields on a User Group object.

Parameters
UserGroup
Request
Returns
UserGroup

Definition at line 214 of file UserGroupForm.inc.php.

References Form\getData().

UserGroupForm::execute (   $request)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
$objectobject The object edited by this form.
Returns
$object The same object, potentially changed via hook.

Definition at line 147 of file UserGroupForm.inc.php.

UserGroupForm::fetch (   $request)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Definition at line 120 of file UserGroupForm.inc.php.

UserGroupForm::getContextId ( )

Get the context id.

Returns
int contextId

Definition at line 68 of file UserGroupForm.inc.php.

Referenced by initData().

UserGroupForm::getLocaleFieldNames ( )

Get all locale field names

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

UserGroupForm::getPermitSelfRegistrationRoles ( )

Get a list of roles optionally permitting user self-registration.

Returns
array

Definition at line 140 of file UserGroupForm.inc.php.

UserGroupForm::getUserGroupId ( )

Get the user group id.

Returns
int userGroupId

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

UserGroupForm::initData ( )

Initialize form data for a new form.

Definition at line 85 of file UserGroupForm.inc.php.

References getContextId(), and Form\setData().

UserGroupForm::readInputData ( )

Assign form data to user-submitted data. Can be overridden from subclasses.

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

UserGroupForm::UserGroupForm (   $contextId,
  $userGroupId = null 
)

Constructor.

Parameters
$contextIdContext id.
$userGroupIdUser group id.

Definition at line 38 of file UserGroupForm.inc.php.

Member Data Documentation

The UserGroupForm::$_contextId

context of the user group being edited

Definition at line 30 of file UserGroupForm.inc.php.

Id UserGroupForm::$_userGroupId

of the user group being edited

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


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