51Degrees Pipeline PHP  4.1

51Degrees Pipeline for PHP

fiftyone\pipeline\core\Evidence Class Reference

Detailed Description

Storage of evidence on a FlowData object.

Public Member Functions

 __construct ($flowData)
evidence container constructor More...
 set ($key, $value)
Set a single piece of evidence by its element and value. More...
 setArray ($array)
Helper function to set multiple pieces of evidence from an array. More...
 setFromWebRequest ($server=null, $cookies=null, $query=null)
Extract evidence from a web request No argument version automatically reads from current request. More...
 get ($key)
Get a piece of evidence by key. More...
 getAll ()
Get all evidence. More...

Protected Attributes

 $flowData
 $evidence = array()

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\core\Evidence::__construct (   $flowData )

evidence container constructor

Parameters
FlowData - parent FlowData

Member Function Documentation

◆ get()

fiftyone\pipeline\core\Evidence::get (   $key )

Get a piece of evidence by key.

Parameters
string - key

◆ getAll()

fiftyone\pipeline\core\Evidence::getAll ( )

Get all evidence.

Returns
mixed[]

◆ set()

fiftyone\pipeline\core\Evidence::set (   $key,
  $value  
)

Set a single piece of evidence by its element and value.

Parameters
string - key
mixed - value

◆ setArray()

fiftyone\pipeline\core\Evidence::setArray (   $array )

Helper function to set multiple pieces of evidence from an array.

Parameters
mixed[] -

◆ setFromWebRequest()

fiftyone\pipeline\core\Evidence::setFromWebRequest (   $server = null,
  $cookies = null,
  $query = null  
)

Extract evidence from a web request No argument version automatically reads from current request.

Parameters
$_SERVER -
$_COOKIE -