|
1
|
|
|
<?php |
|
2
|
|
|
namespace Consolidation\OutputFormatters\StructuredData; |
|
3
|
|
|
|
|
4
|
|
|
use Consolidation\OutputFormatters\StructuredData\RestructureInterface; |
|
5
|
|
|
use Consolidation\OutputFormatters\Options\FormatterOptions; |
|
6
|
|
|
use Consolidation\OutputFormatters\StructuredData\ListDataInterface; |
|
7
|
|
|
use Consolidation\OutputFormatters\Transformations\ReorderFields; |
|
8
|
|
|
use Consolidation\OutputFormatters\Transformations\TableTransformation; |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* Holds an array where each element of the array is one row, |
|
12
|
|
|
* and each row contains an associative array where the keys |
|
13
|
|
|
* are the field names, and the values are the field data. |
|
14
|
|
|
* |
|
15
|
|
|
* It is presumed that every row contains the same keys. |
|
16
|
|
|
*/ |
|
17
|
|
|
abstract class AbstractStructuredList extends \ArrayObject implements RestructureInterface, ListDataInterface |
|
18
|
|
|
{ |
|
19
|
|
|
protected $data; |
|
20
|
|
|
|
|
21
|
|
|
public function __construct($data) |
|
22
|
|
|
{ |
|
23
|
|
|
parent::__construct($data); |
|
24
|
|
|
} |
|
25
|
|
|
|
|
26
|
|
|
abstract public function restructure(FormatterOptions $options); |
|
27
|
|
|
|
|
28
|
|
|
abstract public function getListData(FormatterOptions $options); |
|
29
|
|
|
|
|
30
|
|
|
protected function createTableTransformation($data, $options) |
|
31
|
|
|
{ |
|
32
|
|
|
$defaults = $this->defaultOptions(); |
|
33
|
|
|
$fieldLabels = $this->getReorderedFieldLabels($data, $options, $defaults); |
|
34
|
|
|
|
|
35
|
|
|
$tableTransformer = $this->instantiateTableTransformation($data, $fieldLabels, $options->get(FormatterOptions::ROW_LABELS, $defaults)); |
|
36
|
|
|
if ($options->get(FormatterOptions::LIST_ORIENTATION, $defaults)) { |
|
37
|
|
|
$tableTransformer->setLayout(TableTransformation::LIST_LAYOUT); |
|
38
|
|
|
} |
|
39
|
|
|
|
|
40
|
|
|
return $tableTransformer; |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
protected function instantiateTableTransformation($data, $fieldLabels, $rowLabels) |
|
44
|
|
|
{ |
|
45
|
|
|
return new TableTransformation($data, $fieldLabels, $rowLabels); |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
protected function getReorderedFieldLabels($data, $options, $defaults) |
|
49
|
|
|
{ |
|
50
|
|
|
$reorderer = new ReorderFields(); |
|
51
|
|
|
$fieldLabels = $reorderer->reorder( |
|
52
|
|
|
$this->getFields($options, $defaults), |
|
53
|
|
|
$options->get(FormatterOptions::FIELD_LABELS, $defaults), |
|
54
|
|
|
$data |
|
55
|
|
|
); |
|
56
|
|
|
return $fieldLabels; |
|
57
|
|
|
} |
|
58
|
|
|
|
|
59
|
|
|
protected function getFields($options, $defaults) |
|
60
|
|
|
{ |
|
61
|
|
|
$fieldShortcut = $options->get(FormatterOptions::FIELD); |
|
62
|
|
|
if (!empty($fieldShortcut)) { |
|
63
|
|
|
return [$fieldShortcut]; |
|
64
|
|
|
} |
|
65
|
|
|
$result = $options->get(FormatterOptions::FIELDS, $defaults); |
|
66
|
|
|
if (!empty($result)) { |
|
67
|
|
|
return $result; |
|
68
|
|
|
} |
|
69
|
|
|
return $options->get(FormatterOptions::DEFAULT_FIELDS, $defaults); |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
|
|
/** |
|
73
|
|
|
* A structured list may provide its own set of default options. These |
|
74
|
|
|
* will be used in place of the command's default options (from the |
|
75
|
|
|
* annotations) in instances where the user does not provide the options |
|
76
|
|
|
* explicitly (on the commandline) or implicitly (via a configuration file). |
|
77
|
|
|
* |
|
78
|
|
|
* @return array |
|
79
|
|
|
*/ |
|
80
|
|
|
protected function defaultOptions() |
|
81
|
|
|
{ |
|
82
|
|
|
return [ |
|
83
|
|
|
FormatterOptions::FIELDS => [], |
|
84
|
|
|
FormatterOptions::FIELD_LABELS => [], |
|
85
|
|
|
FormatterOptions::ROW_LABELS => [], |
|
86
|
|
|
FormatterOptions::DEFAULT_FIELDS => [], |
|
87
|
|
|
]; |
|
88
|
|
|
} |
|
89
|
|
|
} |
|
90
|
|
|
|
consolidation /
output-formatters
