NavigateToSceneData
extends EventContextData
in package
NavigateToScene data container which can be used for navigational events.
Fields are: referrer Scene|null viewpoint Viewpoint scene Scene parameters array redirect Scene|null
Table of Contents
- $argumentConfig : array<string|int, mixed>|null
- $data : array<string|int, mixed>
- checkConfiguration() : mixed
- Checks a field configuration given in self::$argumentConfig.
- create() : EventContextData
- Creates a new instance of a data container.
- get() : mixed
- Returns the value of a field.
- has() : bool
- Returns true if container has a certain field.
- set() : EventContextData
- Sets a field to a new value and returns a new data container.
- setFields() : EventContextData
- Sets multiple fields at once.
- __construct() : mixed
- NavigateToScene constructor.
- getFormattedListOfFields() : string
- Returns a comma separated string with all allowed fields, for debugging reasons.
- getListOfFields() : array<string|int, mixed>
- Returns a list of fields in this context.
- throwException() : mixed
- internal use only - throws an ArgumentException a field is given that's not valid.
Properties
$argumentConfig
protected
static array<string|int, mixed>|null
$argumentConfig
= null
$data
private
array<string|int, mixed>
$data
Methods
checkConfiguration()
Checks a field configuration given in self::$argumentConfig.
public
static checkConfiguration(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
Return values
mixed —create()
Creates a new instance of a data container.
public
static create(array<string|int, mixed> $data) : EventContextData
Sub types can change this method to force certain parameters.
Parameters
- $data : array<string|int, mixed>
Return values
EventContextData —get()
Returns the value of a field.
public
get(string $field) : mixed
Parameters
- $field : string
Return values
mixed —has()
Returns true if container has a certain field.
public
has(string $field) : bool
Parameters
- $field : string
Return values
bool —set()
Sets a field to a new value and returns a new data container.
public
set(string $field, mixed $value) : EventContextData
Parameters
- $field : string
- $value : mixed
Return values
EventContextData —setFields()
Sets multiple fields at once.
public
setFields(array<string|int, mixed> $data) : EventContextData
Parameters
- $data : array<string|int, mixed>
-
array of $field=>$value pairs
Return values
EventContextData —__construct()
NavigateToScene constructor.
protected
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
Must contain fields referrer, viewpoint, scene, parameters and redirect; none more.
Tags
Return values
mixed —getFormattedListOfFields()
Returns a comma separated string with all allowed fields, for debugging reasons.
private
getFormattedListOfFields() : string
Return values
string —getListOfFields()
Returns a list of fields in this context.
private
getListOfFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —throwException()
internal use only - throws an ArgumentException a field is given that's not valid.
private
throwException( $field) : mixed