Copied!

Invitation

Invitation.php : 17
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

public__construct()

Invitation.php : 35

Construct object optionally with a set of properties.

 
public __construct(string $email, string $hash, DateTimeInterface $createdAt, string $siteAccessIdentifier, bool $used[, Role|null $role = null ][, UserGroup|null $userGroup = null ][, RoleLimitation|null $limitation = 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 - -
$createdAt DateTimeInterface - -
$siteAccessIdentifier string - -
$used bool - -
$role Role|null null -
$userGroup UserGroup|null null -
$limitation RoleLimitation|null null -

publiccreatedAt()

Invitation.php : 72 
public createdAt() : DateTimeInterface

Return values

DateTimeInterface

publicgetEmail()

Invitation.php : 57 
public getEmail() : string

Return values

string

publicgetHash()

Invitation.php : 62 
public getHash() : string

Return values

string

publicgetLimitation()

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

Return values

RoleLimitation|null

publicgetRole()

Invitation.php : 82 
public getRole() : Role|null

Return values

Role|null

publicgetSiteAccessIdentifier()

Invitation.php : 67 
public getSiteAccessIdentifier() : string

Return values

string

publicgetUserGroup()

Invitation.php : 87 
public getUserGroup() : UserGroup|null

Return values

UserGroup|null

publicisUsed()

Invitation.php : 77 
public isUsed() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 53

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>

Tags
Serializerignore

()