OpenDocument implements JsonSerializable
Read onlyYes
Value object representing an open document in the backend.
An open document represents a record being edited in the FormEngine, displayed in the "open documents" toolbar.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $parameters : array<string|int, mixed>
- $pid : int
- $returnUrl : string
- $table : string
- $title : string
- $uid : string
Methods
- __construct() : mixed
- fromArray() : self
- fromLegacyArray() : self
- Create from the legacy array format stored in session.
- getIdentifier() : string
- Get the identifier for this document (table:uid).
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$parameters
public
array<string|int, mixed>
$parameters
$pid
public
int
$pid
$returnUrl
public
string
$returnUrl
= ''
$table
public
string
$table
$title
public
string
$title
$uid
public
string
$uid
Methods
__construct()
public
__construct(string $table, string $uid, string $title, array<string|int, mixed> $parameters, int $pid[, string $returnUrl = '' ]) : mixed
Parameters
- $table : string
- $uid : string
- $title : string
- $parameters : array<string|int, mixed>
- $pid : int
- $returnUrl : string = ''
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selffromLegacyArray()
Create from the legacy array format stored in session.
public
static fromLegacyArray(array<string|int, mixed> $data) : self
Legacy format: [0 => title, 1 => params, 2 => queryString, 3 => metadata, 4 => returnUrl]
Parameters
- $data : array<string|int, mixed>
Return values
selfgetIdentifier()
Get the identifier for this document (table:uid).
public
getIdentifier() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>