DataGridBuilder::addActionColumn() - Code Metrics - Inspection of "Merge branch 'release/4.0.0'" - pfilsx/DataGridBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f15fe2...9a8393 )

by Pavel

created 2019-10-23 00:41 UTC

DataGridBuilder::addActionColumn() A

↳ Parent: DataGridBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php


namespace Pfilsx\DataGrid\Grid;


use Pfilsx\DataGrid\Config\Configuration;
use Pfilsx\DataGrid\Config\ConfigurationInterface;
use Pfilsx\DataGrid\DataGridServiceContainer;
use Pfilsx\DataGrid\Grid\Columns\AbstractColumn;
use Pfilsx\DataGrid\Grid\Columns\ActionColumn;
use Pfilsx\DataGrid\Grid\Columns\DataColumn;
use InvalidArgumentException;
use Pfilsx\DataGrid\Grid\Columns\SerialColumn;
use Pfilsx\DataGrid\Grid\Providers\DataProviderInterface;

class DataGridBuilder implements DataGridBuilderInterface
{
    /**
     * @var Pager
     */
    protected $pager;
    /**
     * @var DataGridServiceContainer
     */
    protected $container;
    /**
     * @var DataProviderInterface
     */
    protected $provider;

    /**
     * @var AbstractColumn[]
     */
    protected $columns = [];

    protected $hasFilters = false;

    /**
     * @var Configuration
     */
    protected $configuration;

    protected $instance = 'default';

    /**
     * DataGridBuilder constructor.
     * @param DataGridServiceContainer $container
     */
    public function __construct(DataGridServiceContainer $container)
    {
        $this->container = $container;
        $this->configuration = new Configuration();
    }

    /**
     * @param string $attribute
     * @param string $columnClass
     * @param array $options
     * @return $this
     */
    public function addColumn(string $attribute, string $columnClass = DataColumn::class, array $options = []): DataGridBuilderInterface
    {
        if (!is_subclass_of($columnClass, AbstractColumn::class)) {
            throw new InvalidArgumentException('Expected subclass of' . AbstractColumn::class);
        }
        /**
         * @var AbstractColumn $column
         */
        $column = new $columnClass($this->container, array_merge($options, ['attribute' => $attribute]));
        $this->columns[] = $column;
        if ($column->hasFilter() && $column->isVisible()) {
            $this->hasFilters = true;
        }
        return $this;
    }

    /**
     * @param string $attribute
     * @param array $options
     * @return $this
     */
    public function addDataColumn(string $attribute, array $options = []): DataGridBuilderInterface
    {
        return $this->addColumn($attribute, DataColumn::class, $options);
    }

    /**
     * @param array $options
     * @return $this
     */
    public function addActionColumn(array $options = []): DataGridBuilderInterface
    {
        return $this->addColumn('id', ActionColumn::class, $options);
    }

    /**
     * @param array $options
     * @return $this
     */
    public function addSerialColumn(array $options = []): DataGridBuilderInterface
    {
        return $this->addColumn('', SerialColumn::class, $options);
    }

    /**
     * @param string $path
     * @return $this
     */
    public function setTemplate(string $path): DataGridBuilderInterface
    {
        $this->configuration->setTemplate($path);
        return $this;
    }
    /**
     * @param string $message
     * @return $this
     */
    public function setNoDataMessage(string $message): DataGridBuilderInterface
    {
        $this->configuration->setNoDataMessage($message);
        return $this;
    }

    public function enablePagination(bool $enabled = true, ?int $limit = null): DataGridBuilderInterface
    {
        $this->configuration->setPaginationEnabled($enabled);
        if ($limit !== null){
            $this->configuration->setPaginationLimit($limit);
        }
        return $this;
    }

    public function setCountFieldName(string $name): DataGridBuilderInterface
    {
        $this->provider->setCountFieldName($name);
        return $this;
    }

    /**
     * @internal
     * @return AbstractColumn[]
     */
    public function getColumns(): array
    {
        return $this->columns;
    }

    public function getProvider(): DataProviderInterface
    {
        return $this->provider;
    }

    /**
     * @internal
     * @param DataProviderInterface $provider
     */
    public function setProvider(DataProviderInterface $provider): void
    {
        $provider->setPager($this->getPager());
        $this->provider = $provider;
    }

    public function setSort(string $attribute, string $direction)
    {
        foreach ($this->columns as $column) {
            if ($column instanceof DataColumn && $column->hasSort() && $column->getAttribute() == $attribute) {
                $column->setSort($direction);
                $this->provider->setSort([$attribute => $direction]);
                break;
            }
        }
    }

    /**
     * @internal
     * @return bool
     */
    public function hasFilters(): bool
    {
        return $this->hasFilters;
    }

    /**
     * @internal
     * @param array $filters
     */
    public function setFiltersValues(array $filters): void
    {
        foreach ($this->columns as $column) {
            if ($column instanceof DataColumn && $column->hasFilter() && array_key_exists($column->getAttribute(), $filters)) {
                $column->setFilterValue($filters[$column->getAttribute()]);
            }
        }
    }


    /**
     * @internal
     * @return Pager
     */
    public function getPager(): Pager
    {
        return $this->pager ?? ($this->pager = new Pager());
    }

    /**
     * @internal
     * @return bool
     */
    public function hasPagination(): bool
    {
        return $this->getPager()->isEnabled() && is_integer($this->getPager()->getLimit());
    }

    /**
     * @return Configuration
     * @internal
     */
    public function getConfiguration(): ConfigurationInterface
    {
        return $this->configuration;
    }

    /**
     * @internal
     * @return string
     */
    public function getInstance(): string {
        return $this->instance;
    }

    /**
     * @param string $name
     * @return DataGridBuilderInterface
     */
    public function setInstance(string $name): DataGridBuilderInterface {
        $this->instance = $name;
        return $this;
    }

    public function setTranslationDomain(string $domain): DataGridBuilderInterface
    {
        $this->configuration->setTranslationDomain($domain);
        return $this;
    }
}


1			<?php
2
3
4			namespace Pfilsx\DataGrid\Grid;
5
6
7			use Pfilsx\DataGrid\Config\Configuration;
8			use Pfilsx\DataGrid\Config\ConfigurationInterface;
9			use Pfilsx\DataGrid\DataGridServiceContainer;
10			use Pfilsx\DataGrid\Grid\Columns\AbstractColumn;
11			use Pfilsx\DataGrid\Grid\Columns\ActionColumn;
12			use Pfilsx\DataGrid\Grid\Columns\DataColumn;
13			use InvalidArgumentException;
14			use Pfilsx\DataGrid\Grid\Columns\SerialColumn;
15			use Pfilsx\DataGrid\Grid\Providers\DataProviderInterface;
16
17			class DataGridBuilder implements DataGridBuilderInterface
18			{
19			/**
20			* @var Pager
21			*/
22			protected $pager;
23			/**
24			* @var DataGridServiceContainer
25			*/
26			protected $container;
27			/**
28			* @var DataProviderInterface
29			*/
30			protected $provider;
31
32			/**
33			* @var AbstractColumn[]
34			*/
35			protected $columns = [];
36
37			protected $hasFilters = false;
38
39			/**
40			* @var Configuration
41			*/
42			protected $configuration;
43
44			protected $instance = 'default';
45
46			/**
47			* DataGridBuilder constructor.
48			* @param DataGridServiceContainer $container
49			*/
50			public function __construct(DataGridServiceContainer $container)
51			{
52			$this->container = $container;
53			$this->configuration = new Configuration();
54			}
55
56			/**
57			* @param string $attribute
58			* @param string $columnClass
59			* @param array $options
60			* @return $this
61			*/
62			public function addColumn(string $attribute, string $columnClass = DataColumn::class, array $options = []): DataGridBuilderInterface
63			{
64			if (!is_subclass_of($columnClass, AbstractColumn::class)) {
65			throw new InvalidArgumentException('Expected subclass of' . AbstractColumn::class);
66			}
67			/**
68			* @var AbstractColumn $column
69			*/
70			$column = new $columnClass($this->container, array_merge($options, ['attribute' => $attribute]));
71			$this->columns[] = $column;
72			if ($column->hasFilter() && $column->isVisible()) {
73			$this->hasFilters = true;
74			}
75			return $this;
76			}
77
78			/**
79			* @param string $attribute
80			* @param array $options
81			* @return $this
82			*/
83			public function addDataColumn(string $attribute, array $options = []): DataGridBuilderInterface
84			{
85			return $this->addColumn($attribute, DataColumn::class, $options);
86			}
87
88			/**
89			* @param array $options
90			* @return $this
91			*/
92			public function addActionColumn(array $options = []): DataGridBuilderInterface
93			{
94			return $this->addColumn('id', ActionColumn::class, $options);
95			}
96
97			/**
98			* @param array $options
99			* @return $this
100			*/
101			public function addSerialColumn(array $options = []): DataGridBuilderInterface
102			{
103			return $this->addColumn('', SerialColumn::class, $options);
104			}
105
106			/**
107			* @param string $path
108			* @return $this
109			*/
110			public function setTemplate(string $path): DataGridBuilderInterface
111			{
112			$this->configuration->setTemplate($path);
113			return $this;
114			}
115			/**
116			* @param string $message
117			* @return $this
118			*/
119			public function setNoDataMessage(string $message): DataGridBuilderInterface
120			{
121			$this->configuration->setNoDataMessage($message);
122			return $this;
123			}
124
125			public function enablePagination(bool $enabled = true, ?int $limit = null): DataGridBuilderInterface
126			{
127			$this->configuration->setPaginationEnabled($enabled);
128			if ($limit !== null){
129			$this->configuration->setPaginationLimit($limit);
130			}
131			return $this;
132			}
133
134			public function setCountFieldName(string $name): DataGridBuilderInterface
135			{
136			$this->provider->setCountFieldName($name);
137			return $this;
138			}
139
140			/**
141			* @internal
142			* @return AbstractColumn[]
143			*/
144			public function getColumns(): array
145			{
146			return $this->columns;
147			}
148
149			public function getProvider(): DataProviderInterface
150			{
151			return $this->provider;
152			}
153
154			/**
155			* @internal
156			* @param DataProviderInterface $provider
157			*/
158			public function setProvider(DataProviderInterface $provider): void
159			{
160			$provider->setPager($this->getPager());
161			$this->provider = $provider;
162			}
163
164			public function setSort(string $attribute, string $direction)
165			{
166			foreach ($this->columns as $column) {
167			if ($column instanceof DataColumn && $column->hasSort() && $column->getAttribute() == $attribute) {
168			$column->setSort($direction);
169			$this->provider->setSort([$attribute => $direction]);
170			break;
171			}
172			}
173			}
174
175			/**
176			* @internal
177			* @return bool
178			*/
179			public function hasFilters(): bool
180			{
181			return $this->hasFilters;
182			}
183
184			/**
185			* @internal
186			* @param array $filters
187			*/
188			public function setFiltersValues(array $filters): void
189			{
190			foreach ($this->columns as $column) {
191			if ($column instanceof DataColumn && $column->hasFilter() && array_key_exists($column->getAttribute(), $filters)) {
192			$column->setFilterValue($filters[$column->getAttribute()]);
193			}
194			}
195			}
196
197
198			/**
199			* @internal
200			* @return Pager
201			*/
202			public function getPager(): Pager
203			{
204			return $this->pager ?? ($this->pager = new Pager());
205			}
206
207			/**
208			* @internal
209			* @return bool
210			*/
211			public function hasPagination(): bool
212			{
213			return $this->getPager()->isEnabled() && is_integer($this->getPager()->getLimit());
214			}
215
216			/**
217			* @return Configuration
218			* @internal
219			*/
220			public function getConfiguration(): ConfigurationInterface
221			{
222			return $this->configuration;
223			}
224
225			/**
226			* @internal
227			* @return string
228			*/
229			public function getInstance(): string {
230			return $this->instance;
231			}
232
233			/**
234			* @param string $name
235			* @return DataGridBuilderInterface
236			*/
237			public function setInstance(string $name): DataGridBuilderInterface {
238			$this->instance = $name;
239			return $this;
240			}
241
242			public function setTranslationDomain(string $domain): DataGridBuilderInterface
243			{
244			$this->configuration->setTranslationDomain($domain);
245			return $this;
246			}
247			}
248

pfilsx / DataGridBundle

Push — master ( f15fe2...9a8393 )

DataGridBuilder::addActionColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like