class PropertyList extends AbstractStructuredList implements ConversionInterface (View source)

Holds an array where each element of the array is one key : value pair. The keys must be unique, as is typically the case for associative arrays.

Traits

Properties

protected $formatter from  FormatterAwareTrait
protected RenderCellInterface[] $rendererList from  RenderCellCollectionTrait

Methods

__construct($data)

No description

array
getListData(FormatterOptions $options)

Convert data to a format suitable for use in a list.

getReorderedFieldLabels($data, $options, $defaults)

No description

getFields($options, $defaults)

No description

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.

createTableTransformation($data, $options)

No description

instantiateTableTransformation($data, $fieldLabels, $rowLabels)

No description

convert(FormatterOptions $options)

No description

Details

__construct($data)

No description

Parameters

$data

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).

Parameters

FormatterOptions $options

Return Value

array

protected getReorderedFieldLabels($data, $options, $defaults)

No description

Parameters

$data
$options
$defaults

protected getFields($options, $defaults)

No description

Parameters

$options
$defaults

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).

Return Value

array

setFormatter(FormatterInterface $formatter)

No description

Parameters

FormatterInterface $formatter

getFormatter()

No description

isHumanReadable()

No description

$this addRenderer(RenderCellInterface $renderer, $priority = RenderCellCollectionInterface::PRIORITY_NORMAL)

Add a renderer

Parameters

RenderCellInterface $renderer
$priority

Return Value

$this

$this addRendererFunction(callable $rendererFn, $priority = RenderCellCollectionInterface::PRIORITY_NORMAL)

Add a callable as a renderer

Parameters

callable $rendererFn
$priority

Return Value

$this

renderCell($key, $cellData, FormatterOptions $options, $rowData)

{@inheritdoc}

Parameters

$key
$cellData
FormatterOptions $options
$rowData

restructure(FormatterOptions $options)

Restructure this data for output by converting it into a table transformation object.

Parameters

FormatterOptions $options

Formatting options

protected createTableTransformation($data, $options)

No description

Parameters

$data
$options

protected instantiateTableTransformation($data, $fieldLabels, $rowLabels)

No description

Parameters

$data
$fieldLabels
$rowLabels

convert(FormatterOptions $options)

No description

Parameters

FormatterOptions $options

Formatting options