Class humhub\modules\space\models\forms\InviteForm

Inheritancehumhub\modules\space\models\forms\InviteForm » yii\base\Model
Available since version0.5

Public Methods

Hide inherited methods

MethodDescriptionDefined By
attributeLabels() Declares attribute labels. humhub\modules\space\models\forms\InviteForm
canInviteExternal() Checks if external user invitation setting is enabled humhub\modules\space\models\forms\InviteForm
checkInvite() Form Validator which checks the invite field humhub\modules\space\models\forms\InviteForm
checkInviteExternal() Checks a comma separated list of e-mails which should invited to space. humhub\modules\space\models\forms\InviteForm
forceInvite() humhub\modules\space\models\forms\InviteForm
getEmails() E-Mails entered in form humhub\modules\space\models\forms\InviteForm
getInviteIds() humhub\modules\space\models\forms\InviteForm
getInvites() humhub\modules\space\models\forms\InviteForm
getInvitesExternal() Returns an Array with selected recipients humhub\modules\space\models\forms\InviteForm
inviteExternal() Invite external users by mail humhub\modules\space\models\forms\InviteForm
inviteMembers() Invites selected members immediately humhub\modules\space\models\forms\InviteForm
isQueuedJob() humhub\modules\space\models\forms\InviteForm
rules() Declares the validation rules. humhub\modules\space\models\forms\InviteForm
save() Saves the form and either directly invites the selected users directly or by queue if forceinvite or all registered users are selected. humhub\modules\space\models\forms\InviteForm

Property Details

$allRegisteredUsers public property
public $allRegisteredUsers false
$invite public property
public array $invite null
$inviteExternal public property
public string $inviteExternal null
$inviteIds public property

Invite user ids

public integer[] $inviteIds = []
$invites public property
public array $invites = []
$invitesExternal public property
public $invitesExternal = []
$space public property
$withoutInvite public property
public boolean $withoutInvite false

Method Details

attributeLabels() public method

Declares attribute labels.

public void attributeLabels ( )
canInviteExternal() public method

Checks if external user invitation setting is enabled

public integer canInviteExternal ( )
checkInvite() public method

Form Validator which checks the invite field

public void checkInvite ( $attribute, $params )
$attribute string
$params array
checkInviteExternal() public method

Checks a comma separated list of e-mails which should invited to space.

E-Mails needs to be valid and not already registered.

public void checkInviteExternal ( $attribute, $params )
$attribute string
$params array
forceInvite() public method

public void forceInvite ( )
getEmails() public method

E-Mails entered in form

public array getEmails ( )
return array

The emails

getInviteIds() public method

public integer[] getInviteIds ( )
return integer[]

User invite ids

getInvites() public method

public humhub\modules\user\models\User[] getInvites ( )
return humhub\modules\user\models\User[]

An Array with selected recipients

getInvitesExternal() public method

Returns an Array with selected recipients

public void getInvitesExternal ( )
inviteExternal() public method

Invite external users by mail

public void inviteExternal ( )
inviteMembers() public method

Invites selected members immediately

public void inviteMembers ( )
throws \yii\base\Exception
isQueuedJob() public method

public boolean isQueuedJob ( )
return boolean

Checks if

rules() public method

Declares the validation rules.

The rules state that username and password are required, and password needs to be authenticated.

public void rules ( )
save() public method

Saves the form and either directly invites the selected users directly or by queue if forceinvite or all registered users are selected.

public boolean save ( )
return boolean

True if save was successful otherwise false