Class humhub\modules\user\models\forms\Registration

All Classes | Properties | Methods | Events | Constants

Inheritance	humhub\modules\user\models\forms\Registration » humhub\compat\HForm » yii\base\Component

Description of Registration

Public Properties

Hide inherited 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

Hide inherited properties

Property	Type	Description	Defined By
$form			humhub\compat\HForm

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		humhub\compat\HForm
clearErrors()		humhub\compat\HForm
getErrors()		humhub\modules\user\models\forms\Registration
getGroupUser()	Returns Password model	humhub\modules\user\models\forms\Registration
getPassword()	Returns Password model	humhub\modules\user\models\forms\Registration
getProfile()	Returns Profile model	humhub\modules\user\models\forms\Registration
getUser()	Returns User model	humhub\modules\user\models\forms\Registration
init()		humhub\modules\user\models\forms\Registration
register()	Registers users	humhub\modules\user\models\forms\Registration
render()		humhub\modules\user\models\forms\Registration
renderButtons()		humhub\compat\HForm
renderElements()		humhub\compat\HForm
renderField()		humhub\compat\HForm
renderForm()		humhub\compat\HForm
renderFormEnd()		humhub\compat\HForm
save()		humhub\compat\HForm
submitted()		humhub\modules\user\models\forms\Registration
validate()		humhub\modules\user\models\forms\Registration

Protected Methods

Hide inherited 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

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_REGISTRATION	\yii\web\UserEvent	Triggered after successful registration.	humhub\modules\user\models\forms\Registration

Constants

Hide inherited constants

Constant	Value	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

$enableEmailField public property

Show e-mail field

public boolean $enableEmailField = false

$enablePasswordForm public property

Show password creation form

public boolean $enablePasswordForm = true

$enableUserApproval public property

Require user approval by admin after registration.

public boolean|null $enableUserApproval = false

Method Details

getErrors() public method

public void getErrors ( )

getGroupFormDefinition() protected method

protected void getGroupFormDefinition ( )

getGroupUser() public method

Returns Password model

public humhub\modules\user\models\Password getGroupUser ( )

getPassword() public method

Returns Password model

public humhub\modules\user\models\Password getPassword ( )

getPasswordFormDefinition() protected method

Create Password Model form fields required for registration

protected array getPasswordFormDefinition ( )
return	array	Form definition

getProfile() public method

Returns Profile model

public humhub\modules\user\models\Profile getProfile ( )

getUser() public method

Returns User model

public humhub\modules\user\models\User getUser ( )

getUserFormDefinition() protected method

Create User Model form fields required for registration

protected array getUserFormDefinition ( )
return	array	Form definition

init() public method

public void init ( )

Registers users

public boolean register ( \yii\authclient\ClientInterface $authClient = null )
$authClient
return	boolean	State

render() public method

public void render ( $form )
$form

setFormDefinition() protected method

Builds HForm Definition to automatically build form output

protected void setFormDefinition ( )

setModels() protected method

Set models User, Profile and Password to Form

protected void setModels ( )

submitted() public method

public void submitted ( $buttonName = "" )
$buttonName

validate() public method

public void validate ( )

Event Details

EVENT_AFTER_REGISTRATION event of type \yii\web\UserEvent

Triggered after successful registration.