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¶
                
        $hasPublicLink
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        22
                
    
        | 
                     | 
                
                    
                     | 
            
                
        $isActive
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        20
                
    
        | 
                     | 
                
                    
                     | 
            
                
        $owner
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        18
                
    
        | 
                     | 
                
                    
                     | 
            
                
        $token
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        16
                
    
        | 
                     | 
                
                    
                     | 
            
Methods¶
                
__construct()
            ¶
    
        
        ValueObject.php
                :
        32
                
    
        Construct object optionally with a set of 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> | [] | - | 
                
getOwner()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        36
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
UserReference|null
                
getToken()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        26
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
string|null
                
getType()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        24
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
string
                
hasPublicLink()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        56
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
bool|null
                
isActive()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        46
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
bool|null
                
setHasPublicLink()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        61
                
    
        | 
                     | 
                
                    
                     | 
            
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $hasPublicLink | bool|null | - | - | 
                
setIsActive()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        51
                
    
        | 
                     | 
                
                    
                     | 
            
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $isActive | bool|null | - | - | 
                
setOwner()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        41
                
    
        | 
                     | 
                
                    
                     | 
            
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $owner | UserReference|null | - | - | 
                
setToken()
            ¶
    
        
        AbstractSessionUpdateStruct.php
                :
        31
                
    
        | 
                     | 
                
                    
                     | 
            
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $token | string|null | - | - | 
                
getProperties()
            ¶
    
        
        ValueObject.php
                :
        53
                
    
        Returns list of available properties' names.
| 
                     | 
                
                    
                     | 
            
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]