Copied!

AbstractSessionCreateStruct

AbstractSessionCreateStruct.php : 14
Abstract
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.

Properties

AbstractSessionCreateStruct.php : 22 
protected bool|null $hasPublicLink = null

protected $isActive

AbstractSessionCreateStruct.php : 20 
protected bool $isActive = true

protected $owner

AbstractSessionCreateStruct.php : 18 
protected UserReference|null $owner = null

protected $token

AbstractSessionCreateStruct.php : 16 
protected string|null $token = null

Methods

public__construct()

ValueObject.php : 32

Construct object optionally with a set of properties.

 
public __construct([array<string, mixed> $properties = [] ])

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
$properties array<string, mixed> [] -

publicgetOwner()

AbstractSessionCreateStruct.php : 36 
public getOwner() : UserReference|null

Return values

UserReference|null

publicgetToken()

AbstractSessionCreateStruct.php : 26 
public getToken() : string|null

Return values

string|null

publicgetType()

AbstractSessionCreateStruct.php : 24 
public abstract getType() : string

Return values

string

AbstractSessionCreateStruct.php : 51 
public hasPublicLink() : bool|null

Return values

bool|null

publicisActive()

AbstractSessionCreateStruct.php : 46 
public isActive() : bool

Return values

bool

AbstractSessionCreateStruct.php : 56 
public setHasPublicLink(bool $hasPublicLink) : void

Parameters

Name Type Default value Description
$hasPublicLink bool - -

publicsetOwner()

AbstractSessionCreateStruct.php : 41 
public setOwner(UserReference|null $owner) : void

Parameters

Name Type Default value Description
$owner UserReference|null - -

publicsetToken()

AbstractSessionCreateStruct.php : 31 
public setToken(string|null $token) : void

Parameters

Name Type Default value Description
$token string|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]