Copied!

InvitationCreateStruct

InvitationCreateStruct.php : 16
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()

InvitationCreateStruct.php : 18

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

publicgetEmail()

InvitationCreateStruct.php : 28 
public getEmail() : string

Return values

string

publicgetRole()

InvitationCreateStruct.php : 43 
public getRole() : Role|null

Return values

Role|null

publicgetRoleLimitation()

InvitationCreateStruct.php : 48 
public getRoleLimitation() : RoleLimitation|null

Return values

RoleLimitation|null

publicgetSiteAccessIdentifier()

InvitationCreateStruct.php : 33 
public getSiteAccessIdentifier() : string

Return values

string

publicgetUserGroup()

InvitationCreateStruct.php : 38 
public getUserGroup() : UserGroup|null

Return values

UserGroup|null

protectedgetProperties()

ValueObject.php : 53

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>

Attributes
#[Ignore]