Copied!

Handler

Handler.php : 13
Interface

Methods

publiccreateInvitation()

Handler.php : 15 
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

publicfindInvitations()

Handler.php : 34 
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>

publicgetInvitation()

Handler.php : 25 
public getInvitation(string $hash) : Invitation

Parameters

Name Type Default value Description
$hash string - -

Return values

Invitation

publicgetInvitationForEmail()

Handler.php : 27 
public getInvitationForEmail(string $email) : Invitation

Parameters

Name Type Default value Description
$email string - -

Return values

Invitation

publicinvitationExistsForEmail()

Handler.php : 29 
public invitationExistsForEmail(string $email) : bool

Parameters

Name Type Default value Description
$email string - -

Return values

bool

publicmarkAsUsed()

Handler.php : 31 
public markAsUsed(string $hash) : void

Parameters

Name Type Default value Description
$hash string - -

publicrefreshInvitation()

Handler.php : 36 
public refreshInvitation(string $hash, string $newHash) : Invitation

Parameters

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

Return values

Invitation