Copied!

SessionUpdateStruct

SessionUpdateStruct.php : 15
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()

SessionUpdateStruct.php : 27

Construct object optionally with a set of properties.

public __construct(AbstractSessionUpdateStruct $sessionUpdateStruct, string|null $token, UserReference|null $owner, bool|null $isActive, bool|null $hasPublicLink)

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
$sessionUpdateStruct AbstractSessionUpdateStruct - -
$token string|null - -
$owner UserReference|null - -
$isActive bool|null - -
$hasPublicLink bool|null - -

publicgetOwner()

SessionUpdateStruct.php : 53
public getOwner() : UserReference|null

Return values

UserReference|null

publicgetSessionUpdateStruct()

SessionUpdateStruct.php : 43
public getSessionUpdateStruct() : AbstractSessionUpdateStruct

Return values

AbstractSessionUpdateStruct

publicgetToken()

SessionUpdateStruct.php : 48
public getToken() : string|null

Return values

string|null

SessionUpdateStruct.php : 63
public hasPublicLink() : bool|null

Return values

bool|null

publicisActive()

SessionUpdateStruct.php : 58
public isActive() : bool|null

Return values

bool|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]