51Degrees Pipeline for PHP

fiftyone\pipeline\core\ElementDataDictionary Class Reference

Detailed Description

An extension of ElementData with dictionary object storage / lookup.

Inheritance diagram for fiftyone\pipeline\core\ElementDataDictionary:

[legend]

Collaboration diagram for fiftyone\pipeline\core\ElementDataDictionary:

[legend]

Public Member Functions

 __construct (FlowElement $flowElement, array $contents)
 Constructor for element data dictionary.
 asDictionary ()
 Get the values contained in the ElementData instance as a dictionary of keys and values.
 getInternal (string $key)
 Internal getter for contents.

Public Member Functions inherited from fiftyone\pipeline\core\ElementData

 __construct (FlowElement $flowElement)
 __get (string $key)
 get (string $key)
 Get a value from the ElementData contents This calls the ElementData class' (often overridden) getInternal method.
 getAsString (string $key)
 Helper method to get property as a string.
 getAsFloat (string $key)
 Helper method to get property as a float.
 getAsInteger (string $key)
 Helper method to get property as an int.

Data Fields

array $contents

Data Fields inherited from fiftyone\pipeline\core\ElementData

FlowElement $flowElement

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\core\ElementDataDictionary::__construct ( FlowElement $flowElement,
array $contents )

Constructor for element data dictionary.

Parameters
array<string,mixed>$contents Dictionary contents

Member Function Documentation

◆ asDictionary()

fiftyone\pipeline\core\ElementDataDictionary::asDictionary ( )

Get the values contained in the ElementData instance as a dictionary of keys and values.

Returns
array<string, mixed>>

Reimplemented from fiftyone\pipeline\core\ElementData.

◆ getInternal()

fiftyone\pipeline\core\ElementDataDictionary::getInternal ( string $key)

Internal getter for contents.

Returns
mixed

Reimplemented from fiftyone\pipeline\core\ElementData.