Structure
in package
One structure type of a profile, identified by its URI: the same tag can mean different structures in different places (INDI.NAME and REPO.NAME).
Table of Contents
Properties
- $enumerationSet : string|null
- $forms : array<string|int, mixed>
- $payload : string|null
- $substructures : array<string|int, mixed>
- $tag : string
- $uri : string
Methods
- __construct() : mixed
- allowed() : array<string, Substructure>
- The substructures allowed with a payload: in 5.x, those of the form with a pointer or of the inline one, where they differ (form()).
- form() : "pointer"|"inline"|null
- 5.x: the form a payload gives a structure with forms, 'pointer' or 'inline'. A malformed pointer (@S1) is the form with a pointer; a text where the inline form has none (OBJE text) is a wrong value, not a form: null, as for a structure without forms.
- formOf() : "pointer"|"inline"|null
- The form of a structure of a document: its payload is read only for a structure with forms.
- pointerTarget() : string|null
- URI of the record type a pointer payload must point to; null when the payload cannot be a pointer.
- substructure() : Substructure|null
- substructuresOf() : array<string, Substructure>
Properties
$enumerationSet
public
string|null
$enumerationSet
$forms
public
array<string|int, mixed>
$forms
= []
$payload
public
string|null
$payload
$substructures
public
array<string|int, mixed>
$substructures
$tag
public
string
$tag
$uri
public
string
$uri
Methods
__construct()
public
__construct(string $uri, string $tag, string|null $payload, string|null $enumerationSet, array<string, Substructure> $substructures[, array<string|int, mixed> $forms = [] ]) : mixed
Parameters
- $uri : string
- $tag : string
- $payload : string|null
-
payload type URI, "@<record URI>@" for pointers, or alternatives such as "Y|<NULL>" and, in 5.x, "@<record URI>@|<SUBMITTER_TEXT>"; null when there is no payload
- $enumerationSet : string|null
- $substructures : array<string, Substructure>
-
by tag
- $forms : array<string|int, mixed> = []
allowed()
The substructures allowed with a payload: in 5.x, those of the form with a pointer or of the inline one, where they differ (form()).
public
allowed(string|null $payload) : array<string, Substructure>
Parameters
- $payload : string|null
Return values
array<string, Substructure>form()
5.x: the form a payload gives a structure with forms, 'pointer' or 'inline'. A malformed pointer (@S1) is the form with a pointer; a text where the inline form has none (OBJE text) is a wrong value, not a form: null, as for a structure without forms.
public
form(string|null $payload) : "pointer"|"inline"|null
Parameters
- $payload : string|null
Return values
"pointer"|"inline"|nullformOf()
The form of a structure of a document: its payload is read only for a structure with forms.
public
formOf(Document $document, int $id) : "pointer"|"inline"|null
Parameters
- $document : Document
- $id : int
Return values
"pointer"|"inline"|nullpointerTarget()
URI of the record type a pointer payload must point to; null when the payload cannot be a pointer.
public
pointerTarget() : string|null
Return values
string|nullsubstructure()
public
substructure(string $tag) : Substructure|null
Parameters
- $tag : string
Return values
Substructure|nullsubstructuresOf()
public
substructuresOf("pointer"|"inline"|null $form) : array<string, Substructure>
Parameters
- $form : "pointer"|"inline"|null
Return values
array<string, Substructure> —the substructures of a form; null: of any form