RenderOptions
in package
Read onlyYes
FinalYes
Per call options of a render run; unset values fall back to the configuration.
Table of Contents
Constants
- ARRAY_VERSION : int = 1
- Version of the array format of toArray().
Properties
- $country : string|null
- $formats : array<string|int, mixed>
- $locale : string|null
- $options : array<string|int, mixed>
- $presentation : Presentation|null
- $profile : Profile|string|null
- $template : string|null
- $validation : string|null
Methods
- __construct() : mixed
- fromArray() : self
-
toArray()
: array{_version: int, formats: list
, profile: ?string, template: ?string, locale: ?string, country: ?string, validation: ?string, presentation: ?array - The options as array of scalars, e.g. for a queued job; fromArray() restores them.
Constants
ARRAY_VERSION
Version of the array format of toArray().
public
int
ARRAY_VERSION
= 1
Properties
$country
public
string|null
$country
= null
$formats
public
array<string|int, mixed>
$formats
= []
$locale
public
string|null
$locale
= null
$options
public
array<string|int, mixed>
$options
= []
$presentation
public
Presentation|null
$presentation
= null
$profile
public
Profile|string|null
$profile
= null
$template
public
string|null
$template
= null
$validation
public
string|null
$validation
= null
Methods
__construct()
public
__construct([array<int, string> $formats = [] ][, Profile|string|null $profile = null ][, string|null $template = null ][, string|null $locale = null ][, string|null $country = null ][, string|null $validation = null ][, Presentation|null $presentation = null ][, array<string, mixed> $options = [] ]) : mixed
Parameters
- $formats : array<int, string> = []
-
empty = configured or automatically chosen format
- $profile : Profile|string|null = null
- $template : string|null = null
- $locale : string|null = null
- $country : string|null = null
- $validation : string|null = null
- $presentation : Presentation|null = null
- $options : array<string, mixed> = []
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
-
an array of toArray()
Tags
Return values
selftoArray()
The options as array of scalars, e.g. for a queued job; fromArray() restores them.
public
toArray() : array{_version: int, formats: list, profile: ?string, template: ?string, locale: ?string, country: ?string, validation: ?string, presentation: ?array, options: array}
A profile object is stored by its key, so it must be registered where the array is read.