Completed
Pull Request — master (#20)
by Greg
02:41
created

AbstractStructuredList::defaultOptions()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 10
rs 9.4285
cc 1
eloc 7
nc 1
nop 0
1
<?php
2
namespace Consolidation\OutputFormatters\StructuredData;
3
4
use Consolidation\OutputFormatters\RestructureInterface;
5
use Consolidation\OutputFormatters\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
    public abstract function restructure(FormatterOptions $options);
0 ignored issues
show
Coding Style introduced by
The abstract declaration must precede the visibility declaration
Loading history...
27
28
    public abstract function getListData();
0 ignored issues
show
Coding Style introduced by
The abstract declaration must precede the visibility declaration
Loading history...
29
30
    protected function createTableTransformation($data, $options)
31
    {
32
        $defaults = $this->defaultOptions();
33
34
        $reorderer = new ReorderFields();
35
        $fieldLabels = $reorderer->reorder($options->get('fields', $defaults), $options->get('field-labels', $defaults), $data);
36
37
        $tableTransformer = new TableTransformation($data, $fieldLabels, $options->get('row-labels', $defaults));
38
        if ($options->get('list-orientation', $defaults)) {
39
            $tableTransformer->setLayout(TableTransformation::LIST_LAYOUT);
40
        }
41
42
        return $tableTransformer;
43
    }
44
45
    protected function defaultOptions()
46
    {
47
        return [
48
            'list-orientation' => false,
49
            'fields' => [],
50
            'field-labels' => [],
51
            'row-labels' => [],
52
            'default-fields' => [],
53
        ];
54
    }
55
}
56