Copied!

Gateway

Gateway.php : 13
Interface

Methods

publicaddInvitation()

Gateway.php : 28 
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>

publicfindInvitations()

Gateway.php : 57 
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>

publicgetInvitation()

Gateway.php : 38 
public getInvitation(string $hash) : mixed

Parameters

Name Type Default value Description
$hash string - -

publicgetInvitationByEmail()

Gateway.php : 42 
public getInvitationByEmail(string $email) : mixed

Parameters

Name Type Default value Description
$email string - -

publicinvitationExistsForEmail()

Gateway.php : 40 
public invitationExistsForEmail(string $email) : bool

Parameters

Name Type Default value Description
$email string - -

Return values

bool

publicupdateInvitation()

Gateway.php : 59 
public updateInvitation(string $hash, InvitationUpdateStruct $updateStruct) : void

Parameters

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