Class humhub\modules\user\models\forms\Registration
Inheritance | humhub\modules\user\models\forms\Registration » humhub\compat\HForm » yii\base\Component |
---|
Description of Registration
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$definition | humhub\compat\HForm | ||
$enableEmailField | boolean | Show e-mail field | humhub\modules\user\models\forms\Registration |
$enablePasswordForm | boolean | Show password creation form | humhub\modules\user\models\forms\Registration |
$enableUserApproval | boolean|null | Require user approval by admin after registration. | humhub\modules\user\models\forms\Registration |
$markedAsSubmitted | boolean | Manually mark form as submitted | humhub\compat\HForm |
$models | humhub\compat\HForm | ||
$primaryModel | humhub\compat\HForm | ||
$showErrorSummary | humhub\compat\HForm |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$form | humhub\compat\HForm |
Public Methods
Protected Methods
Method | Description | Defined By |
---|---|---|
getGroupFormDefinition() | humhub\modules\user\models\forms\Registration | |
getPasswordFormDefinition() | Create Password Model form fields required for registration | humhub\modules\user\models\forms\Registration |
getUserFormDefinition() | Create User Model form fields required for registration | humhub\modules\user\models\forms\Registration |
setFormDefinition() | Builds HForm Definition to automatically build form output | humhub\modules\user\models\forms\Registration |
setModels() | Set models User, Profile and Password to Form | humhub\modules\user\models\forms\Registration |
Events
Event | Type | Description | Defined By |
---|---|---|---|
EVENT_AFTER_REGISTRATION | \yii\web\UserEvent | Triggered after successful registration. | humhub\modules\user\models\forms\Registration |
Constants
Constant | Value | Description | Defined By |
---|---|---|---|
EVENT_AFTER_INIT | 'afterInit' | humhub\compat\HForm | |
EVENT_AFTER_VALIDATE | 'afterValidate' | humhub\compat\HForm | |
EVENT_BEFORE_RENDER | 'beforeRender' | humhub\compat\HForm | |
EVENT_BEFORE_VALIDATE | 'beforeValidate' | humhub\compat\HForm |
Property Details
Show e-mail field
Show password creation form
Require user approval by admin after registration.
Method Details
public void getErrors ( ) |
protected void getGroupFormDefinition ( ) |
Returns Password model
public humhub\modules\user\models\Password getGroupUser ( ) |
Returns Password model
public humhub\modules\user\models\Password getPassword ( ) |
Create Password Model form fields required for registration
protected array getPasswordFormDefinition ( ) | ||
return | array | Form definition |
---|
Returns Profile model
public humhub\modules\user\models\Profile getProfile ( ) |
Returns User model
public humhub\modules\user\models\User getUser ( ) |
Create User Model form fields required for registration
protected array getUserFormDefinition ( ) | ||
return | array | Form definition |
---|
public void init ( ) |
Registers users
public boolean register ( \yii\authclient\ClientInterface $authClient = null ) | ||
$authClient | ||
return | boolean | State |
---|
public void render ( $form ) | ||
$form |
Builds HForm Definition to automatically build form output
protected void setFormDefinition ( ) |
Set models User, Profile and Password to Form
protected void setModels ( ) |
public void submitted ( $buttonName = "" ) | ||
$buttonName |
public void validate ( ) |