InvitationCreateStruct

InvitationCreateStruct.php : 16 Copy path

Extends ValueObject

The base class for all value objects and structs.

Supports readonly properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using property-read <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Methods¶

__construct() ¶

InvitationCreateStruct.php : 28 Copy path

Construct object optionally with a set of properties.

public __construct(string $email, string $siteAccessIdentifier[, UserGroup|null $userGroup = null ][, Role|null $role = null ][, RoleLimitation|null $roleLimitation = null ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$email	string	-	-
$siteAccessIdentifier	string	-	-
$userGroup	UserGroup\|null	null	-
$role	Role\|null	null	-
$roleLimitation	RoleLimitation\|null	null	-

getEmail() ¶

InvitationCreateStruct.php : 44 Copy path

public getEmail() : string

Return values

string

getRole() ¶

InvitationCreateStruct.php : 59 Copy path

public getRole() : Role|null

Return values

Role|null

getRoleLimitation() ¶

InvitationCreateStruct.php : 64 Copy path

public getRoleLimitation() : RoleLimitation|null

Return values

RoleLimitation|null

getSiteAccessIdentifier() ¶

InvitationCreateStruct.php : 49 Copy path

public getSiteAccessIdentifier() : string

Return values

string

getUserGroup() ¶

InvitationCreateStruct.php : 54 Copy path

public getUserGroup() : UserGroup|null

Return values

UserGroup|null

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>