Handler

Handler.php : 13 Copy path

Methods¶

createInvitation() ¶

Handler.php : 15 Copy path

public createInvitation(string $email, string $siteAccessName, string $hash[, int|null $roleId = null ][, int|null $groupId = null ][, string|null $limitation = null ][, string|null $limitationValue = null ]) : Invitation

Parameters

Name	Type	Default value	Description
$email	string	-	-
$siteAccessName	string	-	-
$hash	string	-	-
$roleId	int\|null	null	-
$groupId	int\|null	null	-
$limitation	string\|null	null	-
$limitationValue	string\|null	null	-

Return values

Invitation

findInvitations() ¶

Handler.php : 34 Copy path

public findInvitations([InvitationFilter|null $invitationsFilter = null ]) : array<string|int, Invitation>

Parameters

Name	Type	Default value	Description
$invitationsFilter	InvitationFilter\|null	null	-

Return values

array<string|int, Invitation>

getInvitation() ¶

Handler.php : 25 Copy path

public getInvitation(string $hash) : Invitation

Parameters

Name	Type	Default value	Description
$hash	string	-	-

Return values

Invitation

getInvitationForEmail() ¶

Handler.php : 27 Copy path

public getInvitationForEmail(string $email) : Invitation

Parameters

Name	Type	Default value	Description
$email	string	-	-

Return values

Invitation

invitationExistsForEmail() ¶

Handler.php : 29 Copy path

public invitationExistsForEmail(string $email) : bool

Parameters

Name	Type	Default value	Description
$email	string	-	-

Return values

bool

markAsUsed() ¶

Handler.php : 31 Copy path

public markAsUsed(string $hash) : void

Parameters

Name	Type	Default value	Description
$hash	string	-	-

refreshInvitation() ¶

Handler.php : 36 Copy path

public refreshInvitation(string $hash, string $newHash) : Invitation

Parameters

Name	Type	Default value	Description
$hash	string	-	-
$newHash	string	-	-

Return values

Invitation