RowsOfFieldsWithMetadata
class RowsOfFieldsWithMetadata extends RowsOfFields implements MetadataInterface, MetadataHolderInterface (View source)
A RowsOfFields data structure that also contains metadata.
Traits
A structured data object may contains some elements that are actually metadata. Metadata is not included in the output of tabular data formatters (e.g. table, csv), although some of these (e.g. table) may render the metadata alongside the data. Raw data formatters (e.g. yaml, json) will render both the data and the metadata.
Properties
| protected | $formatter | from FormatterAwareTrait | |
| protected RenderCellInterface[] | $rendererList | from RenderCellCollectionTrait | |
| protected | $dataKey | from MetadataHolderTrait | |
| protected | $metadataKey | from MetadataHolderTrait |
Methods
A structured list may provide its own set of default options. These will be used in place of the command's default options (from the annotations) in instances where the user does not provide the options explicitly (on the commandline) or implicitly (via a configuration file).
Add a renderer
Add a callable as a renderer
Restructure this data for output by converting it into a table transformation object. First, though, remove any metadata items.
No description
Return the metadata associated with the structured data (if any)
Details
__construct($data)
No description
array
getListData(FormatterOptions $options)
Convert data to a format suitable for use in a list.
By default, the array values will be used. Implement ListDataInterface to use some other criteria (e.g. array keys).
protected
getReorderedFieldLabels($data, $options, $defaults)
No description
protected
getFields($options, $defaults)
No description
protected array
defaultOptions()
A structured list may provide its own set of default options. These will be used in place of the command's default options (from the annotations) in instances where the user does not provide the options explicitly (on the commandline) or implicitly (via a configuration file).
setFormatter(FormatterInterface $formatter)
No description
getFormatter()
No description
isHumanReadable()
No description
$this
addRenderer(RenderCellInterface $renderer, $priority = RenderCellCollectionInterface::PRIORITY_NORMAL)
Add a renderer
$this
addRendererFunction(callable $rendererFn, $priority = RenderCellCollectionInterface::PRIORITY_NORMAL)
Add a callable as a renderer
renderCell($key, $cellData, FormatterOptions $options, $rowData)
{@inheritdoc}
restructure(FormatterOptions $options)
Restructure this data for output by converting it into a table transformation object. First, though, remove any metadata items.
protected
createTableTransformation($data, $options)
No description
protected
instantiateTableTransformation($data, $fieldLabels, $rowLabels)
No description
convert(FormatterOptions $options)
No description
getDataKey()
No description
setDataKey($key)
No description
getMetadataKey()
No description
setMetadataKey($key)
No description
extractData($data)
No description
extractMetadata($data)
No description
reconstruct($data, $metadata)
No description
getMetadata()
Return the metadata associated with the structured data (if any)