1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Attribute
  7. \
  8. SimpleTextExportableAttributeInterface

SimpleTextExportableAttributeInterface

interface SimpleTextExportableAttributeInterface (View source)

Attribute controllers should implement this interface if they support importing/exporting to/from plain text.

For complex data see MulticolumnTextExportableAttributeInterface

Methods

string
getAttributeValueTextRepresentation()

Get a string containing the text representation of the attribute value currently set in the controller.

AbstractValue|null
updateAttributeValueFromTextRepresentation(string $textRepresentation, ErrorList $warnings)

Update or create the attribute value starting from its text representation.

Details

at line 23
string getAttributeValueTextRepresentation()

Get a string containing the text representation of the attribute value currently set in the controller.

Return Value

string

Examples

A boolean attribute may return:
- '0' if $value is false
- '1' if $value is true
- '' if $value is not set.

at line 39
AbstractValue|null updateAttributeValueFromTextRepresentation(string $textRepresentation, ErrorList $warnings)

Update or create the attribute value starting from its text representation.

Parameters

string $textRepresentation

the text representation of the attribute value
ErrorList $warnings

An ErrorList instance that the method can add decoding warnings to

Return Value

AbstractValue|null

Returns NULL if the controller doesn't have already a value and $textRepresentation is empty

Examples

In case of booleans attributes, this may:
- set the attribute value to false if $textRepresentation is '0' (if the value does not exist, the value is created)
- set the attribute value to true if $textRepresentation is '1' (if the value does not exist, the value is created)
- set the attribute value to NULL if $textRepresentation is not '0' or '1'  (if the value does not exist, the value is NOT created)
- add to the $warnings instance a message $textRepresentation is not empty and it's not '0' or '1'