Copied!

Invitation

Invitation.php : 13
Final
Extends ValueObject

The base class for all value objects and structs.

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

Methods

public__construct()

Invitation.php : 33

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 aren't 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 -

publicgetCreatedAtTimestamp()

Invitation.php : 72 
public getCreatedAtTimestamp() : int

Return values

int

publicgetEmail()

Invitation.php : 57 
public getEmail() : string

Return values

string

publicgetGroupId()

Invitation.php : 87 
public getGroupId() : int|null

Return values

int|null

publicgetHash()

Invitation.php : 67 
public getHash() : string

Return values

string

publicgetLimitation()

Invitation.php : 92 
public getLimitation() : string|null

Return values

string|null

publicgetLimitationValue()

Invitation.php : 97 
public getLimitationValue() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

publicgetRoleId()

Invitation.php : 82 
public getRoleId() : int|null

Return values

int|null

publicgetSiteAccessIdentifier()

Invitation.php : 62 
public getSiteAccessIdentifier() : string

Return values

string

publicisUsed()

Invitation.php : 77 
public isUsed() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 54

Returns list of available properties' names.

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

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Tags
Serializerignore

()