Invitation

Invitation.php : 13 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() ¶

Invitation.php : 33 Copy path

Construct object optionally with a set of properties.

    
                        public __construct(string $email, string $hash, string $siteAccessIdentifier, int $createdAtTimestamp, bool $isUsed[, int|null $roleId = null ][, int|null $groupId = null ][, string|null $limitation = null ][, array<string|int, mixed>|null $limitationValue = 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	-	-
$hash	string	-	-
$siteAccessIdentifier	string	-	-
$createdAtTimestamp	int	-	-
$isUsed	bool	-	-
$roleId	int\|null	null	-
$groupId	int\|null	null	-
$limitation	string\|null	null	-
$limitationValue	array<string\|int, mixed>\|null	null	-

getCreatedAtTimestamp() ¶

Invitation.php : 72 Copy path

public getCreatedAtTimestamp() : int

Return values

int

getEmail() ¶

Invitation.php : 57 Copy path

public getEmail() : string

Return values

string

getGroupId() ¶

Invitation.php : 87 Copy path

public getGroupId() : int|null

Return values

int|null

getHash() ¶

Invitation.php : 67 Copy path

public getHash() : string

Return values

string

getLimitation() ¶

Invitation.php : 92 Copy path

public getLimitation() : string|null

Return values

string|null

getLimitationValue() ¶

Invitation.php : 97 Copy path

public getLimitationValue() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

getRoleId() ¶

Invitation.php : 82 Copy path

public getRoleId() : int|null

Return values

int|null

getSiteAccessIdentifier() ¶

Invitation.php : 62 Copy path

public getSiteAccessIdentifier() : string

Return values

string

isUsed() ¶

Invitation.php : 77 Copy path

public isUsed() : bool

Return values

bool

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>