GridColumn::__construct() - Code Metrics - Inspection of "Added an ordering for columns and a default sort" - mmucklo/DtcGridBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1c101f...c673c5 )

by Matthew

created 2017-12-02 23:17 UTC

GridColumn::__construct() B

↳ Parent: GridColumn

Complexity

Conditions	5
Paths	8

Size

Total Lines	27
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
c	0
b	0
f	0
rs	8.439
cc	5
eloc	17
nc	8
nop	6

<?php

namespace Dtc\GridBundle\Grid\Column;

use Dtc\GridBundle\Grid\Source\GridSourceInterface;

class GridColumn extends AbstractGridColumn
{
    protected $formatter;
    protected $field;
    protected $label;
    protected $searchable;
    protected $order;

    /**
     * GridColumn constructor.
     *
     * @param $field
     * @param string|null $label
     * @param mixed       $formatter
     * @param array|null  $options
     * @param bool        $searchable
     * @param int|null    $order      If there are columns that have an order mixed with columns of 'null' order, the null ones will appear last
     */
    public function __construct($field,
            $label = null,
            $formatter = null,
            array $options = null,
            $searchable = true,
            $order = null)
    {
        $this->field = $field;

        if (!$label) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $label = ucwords($field);
        }

        $this->label = $label;
        $this->formatter = $formatter;
        if ($options) {
            $this->setOptions($options);
        }

        $this->searchable = $searchable;

        $this->order = $order;

        if ($this->order !== null && !is_int($this->order)) {
            throw new \InvalidArgumentException('$order must be an integer or null');
        }
    }

    public function isSearchable()
    {
        return $this->searchable;
    }

    public function format($object, GridSourceInterface $gridsource)
    {
        if ($this->formatter) {
            return call_user_func($this->formatter, $object, $this);
        } else {
            return $this->_format($object);
        }
    }

    protected function _format($object)
    {
        $value = null;
        if (is_array($object)) {
            if (isset($object[$this->field])) {
                $value = $object[$this->field];
            }
        } elseif (is_object($object)) {
            $funcPrefix = array(
                    'get',
                    'is',
                    'has',
            );
            foreach ($funcPrefix as $prefix) {
                $methodName = $prefix.$this->field;
                if (method_exists($object, $methodName)) {
                    $value = $object->$methodName();
                    break;
                }
            }
        }
        if (is_object($value)) {

            if ($value instanceof \DateTime) {
                return $value->format(\DateTime::ISO8601);
            }

            return 'object: '.get_class($value);
        } elseif (is_scalar($value)) {
            return $value;
        } elseif (is_array($value)) {
            return 'array: '.print_r($value, true);
        }

        return $value;
    }

    /**
     * @return $formatter

     */
    public function getFormatter()
    {
        return $this->formatter;
    }

    /**
     * @param $formatter
     */
    public function setFormatter($formatter)
    {
        $this->formatter = $formatter;
    }

    public function toArray()
    {
        $retVal = (array) $this;
        unset($retVal['formatter']);

        return $retVal;
    }
}


1		<?php
2
3		namespace Dtc\GridBundle\Grid\Column;
4
5		use Dtc\GridBundle\Grid\Source\GridSourceInterface;
6
7		class GridColumn extends AbstractGridColumn
8		{
9		protected $formatter;
10		protected $field;
11		protected $label;
12		protected $searchable;
13		protected $order;
14
15		/**
16		* GridColumn constructor.
17		*
18		* @param $field
19		* @param string\|null $label
20		* @param mixed $formatter
21		* @param array\|null $options
22		* @param bool $searchable
23		* @param int\|null $order If there are columns that have an order mixed with columns of 'null' order, the null ones will appear last
24		*/
25		public function __construct($field,
26		$label = null,
27		$formatter = null,
28		array $options = null,
29		$searchable = true,
30		$order = null)
31		{
32		$this->field = $field;
33
34		if (!$label) {
		0 ignored issues – show Bug Best Practice introduced 2017-12-02 23:29 UTC by Report Bug Copy Issue Report The expression `$label` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
35		$label = ucwords($field);
36		}
37
38		$this->label = $label;
39		$this->formatter = $formatter;
40		if ($options) {
41		$this->setOptions($options);
42		}
43
44		$this->searchable = $searchable;
45
46		$this->order = $order;
47
48		if ($this->order !== null && !is_int($this->order)) {
49		throw new \InvalidArgumentException('$order must be an integer or null');
50		}
51		}
52
53		public function isSearchable()
54		{
55		return $this->searchable;
56		}
57
58		public function format($object, GridSourceInterface $gridsource)
59		{
60		if ($this->formatter) {
61		return call_user_func($this->formatter, $object, $this);
62		} else {
63		return $this->_format($object);
64		}
65		}
66
67		protected function _format($object)
68		{
69		$value = null;
70		if (is_array($object)) {
71		if (isset($object[$this->field])) {
72		$value = $object[$this->field];
73		}
74		} elseif (is_object($object)) {
75		$funcPrefix = array(
76		'get',
77		'is',
78		'has',
79		);
80		foreach ($funcPrefix as $prefix) {
81		$methodName = $prefix.$this->field;
82		if (method_exists($object, $methodName)) {
83		$value = $object->$methodName();
84		break;
85		}
86		}
87		}
88	View Code Duplication	if (is_object($value)) {
		0 ignored issues – show Duplication introduced 2017-10-12 05:50 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
89		if ($value instanceof \DateTime) {
90		return $value->format(\DateTime::ISO8601);
91		}
92
93		return 'object: '.get_class($value);
94		} elseif (is_scalar($value)) {
95		return $value;
96		} elseif (is_array($value)) {
97		return 'array: '.print_r($value, true);
98		}
99
100		return $value;
101		}
102
103		/**
104		* @return $formatter
		0 ignored issues – show Documentation introduced 2017-12-02 23:29 UTC by Report Bug Copy Issue Report The doc-type `$formatter` could not be parsed: Unknown type name "$formatter" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
105		*/
106		public function getFormatter()
107		{
108		return $this->formatter;
109		}
110
111		/**
112		* @param $formatter
113		*/
114		public function setFormatter($formatter)
115		{
116		$this->formatter = $formatter;
117		}
118
119		public function toArray()
120		{
121		$retVal = (array) $this;
122		unset($retVal['formatter']);
123
124		return $retVal;
125		}
126		}
127

mmucklo / DtcGridBundle

Push — master ( 1c101f...c673c5 )

GridColumn::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like