DocumentSessionContext implements Jsonable
FinalYes
Table of Contents
Interfaces
Methods
- __construct() : mixed
- buildByAttachedObject() : self
- buildByExternalLink() : self
- buildByFile() : self
- buildByObject() : self
- buildFromJson() : self|null
- getAttachedObject() : AttachedObject|null
- getAttachedObjectId() : int|null
- getExternalLink() : ExternalLink|null
- getExternalLinkId() : int|null
- getFile() : File|null
- getObject() : File|null
- getObjectId() : int
- toJson() : array<string|int, mixed>
- tryBuildByAttachedObject() : self
Methods
__construct()
public
__construct(int $objectId[, int $attachedObjectId = null ][, int $externalLinkId = null ]) : mixed
Parameters
- $objectId : int
- $attachedObjectId : int = null
- $externalLinkId : int = null
buildByAttachedObject()
public
static buildByAttachedObject(AttachedObject $attachedObject) : self
Parameters
- $attachedObject : AttachedObject
Return values
selfbuildByExternalLink()
public
static buildByExternalLink(ExternalLink $externalLink) : self
Parameters
- $externalLink : ExternalLink
Return values
selfbuildByFile()
public
static buildByFile(File $file) : self
Parameters
- $file : File
Return values
selfbuildByObject()
public
static buildByObject(BaseObject $baseObject) : self
Parameters
- $baseObject : BaseObject
Return values
selfbuildFromJson()
public
static buildFromJson(string $json) : self|null
Parameters
- $json : string
Return values
self|nullgetAttachedObject()
public
getAttachedObject() : AttachedObject|null
Return values
AttachedObject|nullgetAttachedObjectId()
public
getAttachedObjectId() : int|null
Return values
int|nullgetExternalLink()
public
getExternalLink() : ExternalLink|null
Return values
ExternalLink|nullgetExternalLinkId()
public
getExternalLinkId() : int|null
Return values
int|nullgetFile()
public
getFile() : File|null
Return values
File|nullgetObject()
public
getObject() : File|null
Return values
File|nullgetObjectId()
public
getObjectId() : int
Return values
inttoJson()
public
toJson([mixed $options = 0 ]) : array<string|int, mixed>
Parameters
- $options : mixed = 0
Return values
array<string|int, mixed>tryBuildByAttachedObject()
public
static tryBuildByAttachedObject(AttachedObject|null $attachedObject, File $file) : self
Parameters
- $attachedObject : AttachedObject|null
- $file : File