GridConfig::setDefaultSort() - Code Metrics - Inspection of "default sorting and style attribute" - Nayjest/Grids - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#173)

unknown

created 2017-05-24 10:31 UTC

GridConfig::setDefaultSort() A

↳ Parent: GridConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace Nayjest\Grids;

use Illuminate\Support\Collection;
use Nayjest\Grids\Components\Base\RenderableComponentInterface;
use Nayjest\Grids\Components\Base\TComponent;
use Nayjest\Grids\Components\Base\TRegistry;
use Nayjest\Grids\Components\Base\RegistryInterface;
use Nayjest\Grids\Components\TFoot;
use Nayjest\Grids\Components\THead;
use Nayjest\Grids\Components\Tr;

class GridConfig implements RegistryInterface
{
    use TRegistry;
    use TComponent;

    const SECTION_DO_NOT_RENDER = 'not_render';

    protected $template = 'grids::default';

    /** @var FieldConfig[]|Collection */
    protected $columns;

    /** @var  DataProvider $data_provider */
    protected $data_provider;

    protected $page_size = 50;

    /** @var Collection|FilterConfig[] $filters */
    protected $filters;

    /** @var int */
    protected $caching_time = 0;

    protected $main_template = '*.grid';

    protected $row_component;

    /**
     * @return RenderableComponentInterface
     */
    public function getRowComponent()
    {
        if (!$this->row_component) {
            $this->row_component = (new Tr)
                ->setRenderSection(self::SECTION_DO_NOT_RENDER);
            if ($this->grid) {
                $this->row_component->initialize($this->grid);
            }
            $this->addComponent($this->row_component);
        }
        return $this->row_component;
    }

    /**
     * @param RenderableComponentInterface $rowComponent
     * @return $this
     */
    public function setRowComponent(RenderableComponentInterface $rowComponent)
    {
        $this->row_component = $rowComponent;
        $this->addComponent($rowComponent);
        $rowComponent->setRenderSection(self::SECTION_DO_NOT_RENDER);
        return $this;
    }

    /**
     * Returns default child components.
     *
     *
     * @return \Illuminate\Support\Collection|Components\Base\ComponentInterface[]|array
     */
    protected function getDefaultComponents()
    {
        return [
            new THead,
            new TFoot
        ];
    }

    /**
     * @param string $template
     * @return $this
     */
    public function setTemplate($template)
    {
        $this->template = $template;
        return $this;
    }

    public function setMainTemplate($template)
    {
        $this->main_template = $template;
        return $this;
    }

    public function getMainTemplate()
    {
        return str_replace('*.', "$this->template.", $this->main_template);
    }


    /**
     * @param Collection|FilterConfig[] $filters
     * @return $this
     */
    public function setFilters($filters)
    {
        $this->filters = Collection::make($filters);
        return $this;
    }

    public function getFilters()
    {
        if (null === $this->filters) {
            $this->filters = new Collection();
        }
        return $this->filters;
    }

    /**
     * @return string
     */
    public function getTemplate()
    {
        return $this->template;
    }

    /**
     * @param DataProvider $dataProvider
     * @return $this
     */
    public function setDataProvider(DataProvider $dataProvider)
    {
        $this->data_provider = $dataProvider;
        return $this;
    }

    /**
     * @return DataProvider
     */
    public function getDataProvider()
    {
        return $this->data_provider;
    }

    /**
     * @param FieldConfig[]|Collection $columns
     * @return $this
     */
    public function setColumns($columns)
    {
        $this->columns = Collection::make($columns);
        return $this;
    }

    /**
     * Returns collection of grid columns.
     *
     * @return FieldConfig[]|Collection
     */
    public function getColumns()
    {
        if (null === $this->columns) {
            $this->columns = new Collection;
        }
        return $this->columns;
    }

    /**
     * Returns column by name.
     *
     * @param string $name
     * @return null|FieldConfig
     */
    public function getColumn($name)
    {
        foreach ($this->getColumns() as $column) {
            if ($column->getName() === $name) {
                return $column;
            }
        }

    }

    /**
     * Returns cache expiration time in minutes.
     *
     * @return int
     */
    public function getCachingTime()
    {
        return $this->caching_time;
    }

    /**
     * Sets cache expiration time in minutes.
     *
     * @param int $minutes
     *
     * @return $this
     */
    public function setCachingTime($minutes)
    {
        $this->caching_time = $minutes;
        return $this;
    }

    /**
     * Adds column to grid.
     *
     * @param FieldConfig $column
     * @return $this
     */
    public function addColumn(FieldConfig $column)
    {
        if ($this->columns === null) {
            $this->setColumns([]);
        }
        $this->columns->push($column);
        return $this;
    }

    /**
     * Sets maximal quantity of rows per page.
     *
     * @param int $pageSize
     * @return $this
     */
    public function setPageSize($pageSize)
    {
        $this->page_size = (int)$pageSize;
        return $this;
    }

    /**
     * Returns maximal quantity of rows per page.
     *
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }
    /**
     * Returns maximal quantity of rows per page.
     *
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    public function setDefaultSort($columnName, $direction)
    {
        $this->defaultSort = [$columnName, $direction];
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getDefaultSort()
    {
        return $this->defaultSort;
    }
}


1			<?php
2			namespace Nayjest\Grids;
3
4			use Illuminate\Support\Collection;
5			use Nayjest\Grids\Components\Base\RenderableComponentInterface;
6			use Nayjest\Grids\Components\Base\TComponent;
7			use Nayjest\Grids\Components\Base\TRegistry;
8			use Nayjest\Grids\Components\Base\RegistryInterface;
9			use Nayjest\Grids\Components\TFoot;
10			use Nayjest\Grids\Components\THead;
11			use Nayjest\Grids\Components\Tr;
12
13			class GridConfig implements RegistryInterface
14			{
15			use TRegistry;
16			use TComponent;
17
18			const SECTION_DO_NOT_RENDER = 'not_render';
19
20			protected $template = 'grids::default';
21
22			/** @var FieldConfig[]\|Collection */
23			protected $columns;
24
25			/** @var DataProvider $data_provider */
26			protected $data_provider;
27
28			protected $page_size = 50;
29
30			/** @var Collection\|FilterConfig[] $filters */
31			protected $filters;
32
33			/** @var int */
34			protected $caching_time = 0;
35
36			protected $main_template = '*.grid';
37
38			protected $row_component;
39
40			/**
41			* @return RenderableComponentInterface
42			*/
43			public function getRowComponent()
44			{
45			if (!$this->row_component) {
46			$this->row_component = (new Tr)
47			->setRenderSection(self::SECTION_DO_NOT_RENDER);
48			if ($this->grid) {
49			$this->row_component->initialize($this->grid);
50			}
51			$this->addComponent($this->row_component);
52			}
53			return $this->row_component;
54			}
55
56			/**
57			* @param RenderableComponentInterface $rowComponent
58			* @return $this
59			*/
60			public function setRowComponent(RenderableComponentInterface $rowComponent)
61			{
62			$this->row_component = $rowComponent;
63			$this->addComponent($rowComponent);
64			$rowComponent->setRenderSection(self::SECTION_DO_NOT_RENDER);
65			return $this;
66			}
67
68			/**
69			* Returns default child components.
70			*
71			*
72			* @return \Illuminate\Support\Collection\|Components\Base\ComponentInterface[]\|array
73			*/
74			protected function getDefaultComponents()
75			{
76			return [
77			new THead,
78			new TFoot
79			];
80			}
81
82			/**
83			* @param string $template
84			* @return $this
85			*/
86			public function setTemplate($template)
87			{
88			$this->template = $template;
89			return $this;
90			}
91
92			public function setMainTemplate($template)
93			{
94			$this->main_template = $template;
95			return $this;
96			}
97
98			public function getMainTemplate()
99			{
100			return str_replace('*.', "$this->template.", $this->main_template);
101			}
102
103
104			/**
105			* @param Collection\|FilterConfig[] $filters
106			* @return $this
107			*/
108			public function setFilters($filters)
109			{
110			$this->filters = Collection::make($filters);
111			return $this;
112			}
113
114			public function getFilters()
115			{
116			if (null === $this->filters) {
117			$this->filters = new Collection();
118			}
119			return $this->filters;
120			}
121
122			/**
123			* @return string
124			*/
125			public function getTemplate()
126			{
127			return $this->template;
128			}
129
130			/**
131			* @param DataProvider $dataProvider
132			* @return $this
133			*/
134			public function setDataProvider(DataProvider $dataProvider)
135			{
136			$this->data_provider = $dataProvider;
137			return $this;
138			}
139
140			/**
141			* @return DataProvider
142			*/
143			public function getDataProvider()
144			{
145			return $this->data_provider;
146			}
147
148			/**
149			* @param FieldConfig[]\|Collection $columns
150			* @return $this
151			*/
152			public function setColumns($columns)
153			{
154			$this->columns = Collection::make($columns);
155			return $this;
156			}
157
158			/**
159			* Returns collection of grid columns.
160			*
161			* @return FieldConfig[]\|Collection
162			*/
163			public function getColumns()
164			{
165			if (null === $this->columns) {
166			$this->columns = new Collection;
167			}
168			return $this->columns;
169			}
170
171			/**
172			* Returns column by name.
173			*
174			* @param string $name
175			* @return null\|FieldConfig
176			*/
177			public function getColumn($name)
178			{
179			foreach ($this->getColumns() as $column) {
180			if ($column->getName() === $name) {
181			return $column;
182			}
183			}
184
185			}
186
187			/**
188			* Returns cache expiration time in minutes.
189			*
190			* @return int
191			*/
192			public function getCachingTime()
193			{
194			return $this->caching_time;
195			}
196
197			/**
198			* Sets cache expiration time in minutes.
199			*
200			* @param int $minutes
201			*
202			* @return $this
203			*/
204			public function setCachingTime($minutes)
205			{
206			$this->caching_time = $minutes;
207			return $this;
208			}
209
210			/**
211			* Adds column to grid.
212			*
213			* @param FieldConfig $column
214			* @return $this
215			*/
216			public function addColumn(FieldConfig $column)
217			{
218			if ($this->columns === null) {
219			$this->setColumns([]);
220			}
221			$this->columns->push($column);
222			return $this;
223			}
224
225			/**
226			* Sets maximal quantity of rows per page.
227			*
228			* @param int $pageSize
229			* @return $this
230			*/
231			public function setPageSize($pageSize)
232			{
233			$this->page_size = (int)$pageSize;
234			return $this;
235			}
236
237			/**
238			* Returns maximal quantity of rows per page.
239			*
240			* @return int
241			*/
242			public function getPageSize()
243			{
244			return $this->page_size;
245			}
246			/**
247			* Returns maximal quantity of rows per page.
248			*
249			* @return int
250			*/
251			public function getPageSize()
252			{
253			return $this->page_size;
254			}
255
256			public function setDefaultSort($columnName, $direction)
257			{
258			$this->defaultSort = [$columnName, $direction];
			0 ignored issues – show Bug introduced 2017-05-24 10:21 UTC by Report Bug Copy Issue Report The property `defaultSort` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
259			}
260
261			public function getDefaultSort()
262			{
263			return $this->defaultSort;
264			}
265			}
266

Nayjest / Grids

Pull Request — master (#173)

GridConfig::setDefaultSort() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like