Detailed Description
Storage of evidence on a FlowData object.
Collaboration diagram for fiftyone\pipeline\core\Evidence:
Public Member Functions | |
| __construct (FlowData $flowData) | |
| Evidence container constructor. | |
| set (string $key, $value) | |
| If a flow element can use the key then add the key value pair to the evidence collection. | |
| setArray ($array) | |
| Helper function to set multiple pieces of evidence from an array. | |
| setFromWebRequest (?array $server=null, ?array $cookies=null, ?array $query=null) | |
| Extract evidence from a web request No argument version automatically reads from current request using the $_SERVER, $_COOKIE, $_GET and $_POST globals. | |
| get (string $key) | |
| Get a piece of evidence by key. | |
| getAll () | |
| Get all evidence. | |
Protected Attributes | |
| FlowData | $flowData |
| array | $evidence = [] |
Constructor & Destructor Documentation
◆ __construct()
| fiftyone\pipeline\core\Evidence::__construct | ( | FlowData | $flowData | ) |
Evidence container constructor.
- Parameters
-
\fiftyone\pipeline\core\FlowData $flowData Parent FlowData
Member Function Documentation
◆ get()
| fiftyone\pipeline\core\Evidence::get | ( | string | $key | ) |
Get a piece of evidence by key.
- Returns
- null|int|string
◆ getAll()
| fiftyone\pipeline\core\Evidence::getAll | ( | ) |
Get all evidence.
- Returns
- array<string, int|string>
◆ set()
| fiftyone\pipeline\core\Evidence::set | ( | string | $key, |
| $value ) |
If a flow element can use the key then add the key value pair to the evidence collection.
- Parameters
-
int | string $value
◆ setArray()
| fiftyone\pipeline\core\Evidence::setArray | ( | $array | ) |
Helper function to set multiple pieces of evidence from an array.
- Parameters
-
array<string,int|string> $array
◆ setFromWebRequest()
| fiftyone\pipeline\core\Evidence::setFromWebRequest | ( | ?array | $server = null, |
| ?array | $cookies = null, | ||
| ?array | $query = null ) |
Extract evidence from a web request No argument version automatically reads from current request using the $_SERVER, $_COOKIE, $_GET and $_POST globals.
- Parameters
-
null|array<string,string> $server Key-value pairs for the HTTP headers null|array<string,string> $cookies Key-value pairs for the cookies null|array<string,string> $query Key-value pairs for the form parameters