ResultParameters
Class ResultParameters
Table of Contents
Constants
- EVENT_FIELDS_FILE = 'fields-file'
Methods
- __construct() : mixed
- ResultParameters constructor.
- addCallback() : $this
- Add callback.
- addVisitedPage() : $this
- Add visited page.
- getCommonFields() : array<string|int, mixed>
- getFieldsMap() : array<string|int, mixed>
- Get fields map.
- getPlaceholders() : array<string|int, mixed>
- Get placeholders.
- getStopCallback() : bool
- Get stop callback.
- setFields() : $this
- Set fields.
- setFromUrl() : $this
- Set from.
- setPresets() : $this
- Set presets.
- setStopCallback() : $this
- Set stop callback.
- toArray() : array<string|int, mixed>
- To array.
Constants
EVENT_FIELDS_FILE
public
mixed
EVENT_FIELDS_FILE
= 'fields-file'
Methods
__construct()
ResultParameters constructor.
public
__construct(Form $form) : mixed
Parameters
- $form : Form
-
Form instance.
addCallback()
Add callback.
public
addCallback(string $event, callable $callable) : $this
Parameters
- $event : string
-
Event.
- $callable : callable
-
Event handler.
Return values
$thisaddVisitedPage()
Add visited page.
public
addVisitedPage(string $url, string $title, int $timestamp) : $this
Parameters
- $url : string
-
Url.
- $title : string
-
Title.
- $timestamp : int
-
Timestamp.
Return values
$thisgetCommonFields()
public
getCommonFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getFieldsMap()
Get fields map.
public
getFieldsMap() : array<string|int, mixed>
Return values
array<string|int, mixed>getPlaceholders()
Get placeholders.
public
getPlaceholders() : array<string|int, mixed>
Return values
array<string|int, mixed>getStopCallback()
Get stop callback.
public
getStopCallback() : bool
Return values
boolsetFields()
Set fields.
public
setFields(array<string|int, mixed> $fields) : $this
Parameters
- $fields : array<string|int, mixed>
-
Fields.
Return values
$thissetFromUrl()
Set from.
public
setFromUrl(null|string $fromUrl) : $this
Parameters
- $fromUrl : null|string
-
From url.
Return values
$thissetPresets()
Set presets.
public
setPresets(array<string|int, mixed> $presets) : $this
Parameters
- $presets : array<string|int, mixed>
-
Presets.
Return values
$thissetStopCallback()
Set stop callback.
public
setStopCallback(bool $stopCallback) : $this
Parameters
- $stopCallback : bool
-
Stop callback.
Return values
$thistoArray()
To array.
public
toArray() : array<string|int, mixed>