CheckboxList::getValue() - Code Metrics - Inspection of "V request context" - funivan/form - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#28)

by Vitaliy

created 2016-05-25 12:49 UTC

CheckboxList::getValue() A

↳ Parent: CheckboxList

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	1	Features	1

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

<?php

  namespace Fiv\Form\Element;


  /**
   * Class TextArea
   * Generate
   * ```html
   * <input type="checkbox" name="languages[]" value="en">
   * <input type="checkbox" name="languages[]" value="ru">
   * ```
   * html tags
   *
   * @author  Ivan Shcherbak <[email protected]>
   * @package Fiv\Form
   */
  class CheckboxList extends Multiple {

    /**
     * @param array|string $data
     * @return $this
     */
    public function setValue($data) {
      if (!is_array($data)) {
        $data = (array) $data;
      }

      foreach ($data as $i => $value) {
        # remove invalid values
        if (!isset($this->options[$value])) {
          unset($data[$i]);
        }
      }

      $this->value = array_values($data);

      return $this;
    }


    /**
     * @return array
     */
    public function getValue() {
      return (array) parent::getValue();
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 $optionKey
     * @return bool
     */
    public function isChecked($optionKey) {
      return in_array($optionKey, $this->getValue());
    }


    /**
     * Alias of setValue
     *
     * @param string[] $values
     * @return $this
     */
    public function setChecked($values) {
      return $this->setValue($values);
    }


    /**
     * @return string
     */
    public function render() {
      $html = '';
      $currentValues = $this->getValue();
      $attributes = $this->attributes;
      $attributes['type'] = 'checkbox';

      $name = $this->getName();

      foreach ($this->options as $value => $text) {
        $attributes['value'] = $value;
        $attributes['name'] = $name . '[]';
        if (in_array($value, $currentValues)) {
          $attributes['checked'] = 'checked';
        } else {
          unset($attributes['checked']);
        }

        $html .= '<label>' . static::tag('input', $attributes) . $text . '</label>';
      }

      return $html;
    }
  }

1		<?php
2
3		namespace Fiv\Form\Element;
4
5
6		/**
7		* Class TextArea
8		* Generate
9		* ```html
10		* <input type="checkbox" name="languages[]" value="en">
11		* <input type="checkbox" name="languages[]" value="ru">
12		* ```
13		* html tags
14		*
15		* @author Ivan Shcherbak <[email protected]>
16		* @package Fiv\Form
17		*/
18		class CheckboxList extends Multiple {
19
20		/**
21		* @param array\|string $data
22		* @return $this
23		*/
24	1	public function setValue($data) {
25	1	if (!is_array($data)) {
26		$data = (array) $data;
27		}
28
29	1	foreach ($data as $i => $value) {
30		# remove invalid values
31	1	if (!isset($this->options[$value])) {
32	1	unset($data[$i]);
33		}
34		}
35
36	1	$this->value = array_values($data);
		0 ignored issues – show Documentation Bug introduced 2016-01-18 09:56 UTC by Report Bug Copy Issue Report It seems like `array_values($data)` of type `array<integer,?>` is incompatible with the declared type `null\|string` of property `$value`. 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...
37	1	return $this;
38		}
39
40
41		/**
42		* @return array
43		*/
44	2	public function getValue() {
45	2	return (array) parent::getValue();
		0 ignored issues – show Bug Best Practice introduced 2016-05-25 06:57 UTC by Report Bug Copy Issue Report The return type of `return (array) parent::getValue();` (`array`) is incompatible with the return type of the parent method `Fiv\Form\Element\BaseElement::getValue` of type `null\|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...
46		}
47
48
49		/**
50		* @param string $optionKey
51		* @return bool
52		*/
53	1	public function isChecked($optionKey) {
54	1	return in_array($optionKey, $this->getValue());
55		}
56
57
58		/**
59		* Alias of setValue
60		*
61		* @param string[] $values
62		* @return $this
63		*/
64		public function setChecked($values) {
65		return $this->setValue($values);
66		}
67
68
69		/**
70		* @return string
71		*/
72	1	public function render() {
73	1	$html = '';
74	1	$currentValues = $this->getValue();
75	1	$attributes = $this->attributes;
76	1	$attributes['type'] = 'checkbox';
77
78	1	$name = $this->getName();
79
80	1	foreach ($this->options as $value => $text) {
81	1	$attributes['value'] = $value;
82	1	$attributes['name'] = $name . '[]';
83	1	if (in_array($value, $currentValues)) {
84		$attributes['checked'] = 'checked';
85		} else {
86	1	unset($attributes['checked']);
87		}
88
89	1	$html .= '<label>' . static::tag('input', $attributes) . $text . '</label>';
90		}
91
92	1	return $html;
93		}
94		}

funivan / form

Pull Request — master (#28)

CheckboxList::getValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like