Column::getOptions() - Code Metrics - Inspection of "Define a type for each column" - CrossKnowledge/DataTableBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

unknown

created 2016-04-29 09:48 UTC

Column::getOptions() A

↳ Parent: Column

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace CrossKnowledge\DataTableBundle\DataTable\Table\Element\Column;

use Symfony\Component\OptionsResolver\OptionsResolver;

class Column implements ColumnInterface
{
    const TYPE = 'string';

    /**
     * Column field info that might be used client side
     *
     * https://datatables.net/reference/option/columns
     *
     * @var array
     */
    public static $clientSideColumnOptions = [
        'cellType','className','contentPadding', 'createdCell', 'data', 'defaultContent', 'name', 'orderable',
        'orderData', 'orderDataType', 'render', 'searchable', 'title', 'type', 'visible', 'width'
    ];

    /**
     * @var string key/value of options
     */
    protected $options;

    /**
     * @var OptionsResolver
     */
    protected $optionsResolver;

    /**
     * @var \Closure callback that will be used to format this cell values
     */
    protected $formatValueCallback;

    public function __construct($title='', $options=[])

    {
        $this->optionsResolver = new OptionsResolver();
        $this->configureOptions($this->optionsResolver);
        $this->setOptions(array_merge($options, ['title' => $title]));
    }
    /**
     * Column unique identifier
     * @param string $identifier
     * @return Column
     */
    public function setIdentifier($identifier)
    {
        $this->identifier = $identifier;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        return $this;
    }
    /**
     * @param OptionsResolver $resolver
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefined('title');
        $resolver->setDefault('auto_escape', true);
        $resolver->setDefault('type', static::TYPE);
        $resolver->setDefined(static::$clientSideColumnOptions);
    }
    /**
     * @param array $options one within static::$clientSideColumnOptions
     */
    public function setOptions(array $options)
    {
        $this->options = $this->optionsResolver->resolve($options);

        return $this;
    }
    /**
     * @return mixed
     */
    public function getOptions()
    {
        return $this->options;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
    /**
     * @param string $title
     * @return Column
     */
    public function setTitle($title)
    {
        $this->options['title'] = $title;
        return $this;
    }

    /**
     * Format a cell content for this column
     * @param $value
     * @param array $rowData
     * @param $context
     * @return mixed
     */
    public function formatCell($value, array $rowData, $context)
    {
        if (is_callable($this->formatValueCallback)) {
            return call_user_func_array($this->formatValueCallback, [$value, $rowData]);
        } else{

            return $value;
        }
    }

    /**
     * @return \Closure
     */
    public function getFormatValueCallback()
    {
        return $this->formatValueCallback;
    }
    /**
     * @param \Closure $callback
     */
    public function setFormatValueCallback(\Closure $callback=null)

    {
        $this->formatValueCallback = $callback;
        return $this;
    }
    /**
     * @return string key/value filtered for client side API
     */
    public function getClientSideDefinition()
    {
        $infos = [];

        array_walk($this->options, function($optval, $optname) use (&$infos) {

            if (in_array($optname, static::$clientSideColumnOptions)) {
                $infos[$optname] = $optval;
            }
        });

        return $infos;
    }
}


1		<?php
2
3		namespace CrossKnowledge\DataTableBundle\DataTable\Table\Element\Column;
4
5		use Symfony\Component\OptionsResolver\OptionsResolver;
6
7		class Column implements ColumnInterface
8		{
9		const TYPE = 'string';
10
11		/**
12		* Column field info that might be used client side
13		*
14		* https://datatables.net/reference/option/columns
15		*
16		* @var array
17		*/
18		public static $clientSideColumnOptions = [
19		'cellType','className','contentPadding', 'createdCell', 'data', 'defaultContent', 'name', 'orderable',
20		'orderData', 'orderDataType', 'render', 'searchable', 'title', 'type', 'visible', 'width'
21		];
22
23		/**
24		* @var string key/value of options
25		*/
26		protected $options;
27
28		/**
29		* @var OptionsResolver
30		*/
31		protected $optionsResolver;
32
33		/**
34		* @var \Closure callback that will be used to format this cell values
35		*/
36		protected $formatValueCallback;
37
38	14	public function __construct($title='', $options=[])
		0 ignored issues – show Coding Style introduced 2016-02-09 09:08 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$title" and equals sign; expected 1 but found 0 Loading history... Coding Style introduced 2016-02-09 09:08 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$title"; expected 1 but found 0 Loading history... Coding Style introduced 2016-02-09 09:08 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$options" and equals sign; expected 1 but found 0 Loading history... Coding Style introduced 2016-02-09 09:08 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$options"; expected 1 but found 0 Loading history...
39		{
40	14	$this->optionsResolver = new OptionsResolver();
41	14	$this->configureOptions($this->optionsResolver);
42	14	$this->setOptions(array_merge($options, ['title' => $title]));
43	13	}
44		/**
45		* Column unique identifier
46		* @param string $identifier
47		* @return Column
48		*/
49	2	public function setIdentifier($identifier)
50		{
51	2	$this->identifier = $identifier;
		0 ignored issues – show Bug introduced 2015-12-18 12:43 UTC by Report Bug Copy Issue Report The property `identifier` 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...
52	2	return $this;
53		}
54		/**
55		* @param OptionsResolver $resolver
56		*/
57	14	public function configureOptions(OptionsResolver $resolver)
58		{
59	14	$resolver->setDefined('title');
60	14	$resolver->setDefault('auto_escape', true);
61	14	$resolver->setDefault('type', static::TYPE);
62	14	$resolver->setDefined(static::$clientSideColumnOptions);
63	14	}
64		/**
65		* @param array $options one within static::$clientSideColumnOptions
66		*/
67	14	public function setOptions(array $options)
68		{
69	14	$this->options = $this->optionsResolver->resolve($options);
		0 ignored issues – show Documentation Bug introduced 2015-12-18 12:43 UTC by Report Bug Copy Issue Report It seems like `$this->optionsResolver->resolve($options)` of type `array` is incompatible with the declared type `string` of property `$options`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
70	13	return $this;
71		}
72		/**
73		* @return mixed
74		*/
75	4	public function getOptions()
76		{
77	4	return $this->options;
		0 ignored issues – show Bug Best Practice introduced 2015-12-18 12:43 UTC by Report Bug Copy Issue Report The return type of `return $this->options;` (`string`) is incompatible with the return type declared by the interface `CrossKnowledge\DataTable...mnInterface::getOptions` of type `string[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
78		}
79		/**
80		* @param string $title
81		* @return Column
82		*/
83		public function setTitle($title)
84		{
85		$this->options['title'] = $title;
86		return $this;
87		}
88
89		/**
90		* Format a cell content for this column
91		* @param $value
92		* @param array $rowData
93		* @param $context
94		* @return mixed
95		*/
96	3	public function formatCell($value, array $rowData, $context)
97		{
98	3	if (is_callable($this->formatValueCallback)) {
99		return call_user_func_array($this->formatValueCallback, [$value, $rowData]);
100		} else{
		0 ignored issues – show Coding Style introduced 2015-12-18 13:00 UTC by Report Bug Copy Issue Report Expected 1 space after ELSE keyword; 0 found Loading history...
101	3	return $value;
102		}
103		}
104
105		/**
106		* @return \Closure
107		*/
108	1	public function getFormatValueCallback()
109		{
110	1	return $this->formatValueCallback;
111		}
112		/**
113		* @param \Closure $callback
114		*/
115	2	public function setFormatValueCallback(\Closure $callback=null)
		0 ignored issues – show Coding Style introduced 2016-02-09 09:08 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$callback" and equals sign; expected 1 but found 0 Loading history... Coding Style introduced 2016-02-09 09:08 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$callback"; expected 1 but found 0 Loading history...
116		{
117	2	$this->formatValueCallback = $callback;
118	2	return $this;
119		}
120		/**
121		* @return string key/value filtered for client side API
122		*/
123	2	public function getClientSideDefinition()
124		{
125	2	$infos = [];
126
127		array_walk($this->options, function($optval, $optname) use (&$infos) {
		0 ignored issues – show Coding Style introduced 2016-03-25 09:52 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
128	2	if (in_array($optname, static::$clientSideColumnOptions)) {
129	2	$infos[$optname] = $optval;
130	2	}
131	2	});
132
133	2	return $infos;
134		}
135		}
136

CrossKnowledge / DataTableBundle

GitHub Access Token became invalid

Pull Request — master (#7)

Column::getOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like