Gateway

Gateway.php : 13 Copy path

Interface

Methods¶

addInvitation() ¶

Gateway.php : 28 Copy path

    
                        public addInvitation(string $email, string $siteAccessName, string $hash[, int|null $roleId = null ][, int|null $userGroupId = null ][, string|null $limitation = null ][, string|null $limitationValue = null ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

findInvitations() ¶

Gateway.php : 57 Copy path

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

Parameters

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

Return values

array<string|int, mixed>

getInvitation() ¶

Gateway.php : 38 Copy path

public getInvitation(string $hash) : mixed

Parameters

Name	Type	Default value	Description
$hash	string	-	-

getInvitationByEmail() ¶

Gateway.php : 42 Copy path

public getInvitationByEmail(string $email) : mixed

Parameters

Name	Type	Default value	Description
$email	string	-	-

invitationExistsForEmail() ¶

Gateway.php : 40 Copy path

public invitationExistsForEmail(string $email) : bool

Parameters

Name	Type	Default value	Description
$email	string	-	-

Return values

bool

updateInvitation() ¶

Gateway.php : 59 Copy path

public updateInvitation(string $hash, InvitationUpdateStruct $updateStruct) : void

Parameters

Name	Type	Default value	Description
$hash	string	-	-
$updateStruct	InvitationUpdateStruct	-	-