OptGroup::setValue() - Code Metrics - Inspection of "Add support for optgroup-tags for select-fields" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/OptGroups ( aae4de...238a07 )

by Michael

created 2016-12-12 17:13 UTC

OptGroup::setValue() A

↳ Parent: OptGroup

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace dokuwiki\Form;


class OptGroup extends Element {
    protected $options = array();
    protected $value;

    /**
     * @param string $name The name of this form element
     * @param string $options The available options
     * @param string $label The label text for this element (will be autoescaped)
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct($name, $options) {
        parent::__construct('optGroup', array('label' => $name));
        $this->options($options);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Set the element's value
     *
     * This is intended to be only called from within @see DropdownElement::val()
     *
     * @param string $value
     * @return bool
     */
    public function setValue($value) {
        $this->value = $value;
        return isset($this->options[$value]);
    }

    /**
     * Get or set the options of the optgroup
     *
     * Options can be given as associative array (value => label) or as an
     * indexd array (label = value) or as an array of arrays. In the latter
     * case an element has to look as follows:
     * option-value => array (
     *                 'label' => option-label,
     *                 'attrs' => array (
     *                                    attr-key => attr-value, ...
     *                                  )
     *                 )
     *
     * @param null|array $options
     * @return $this|array
     */
    public function options($options = null) {
        if($options === null) return $this->options;
        if(!is_array($options)) throw new \InvalidArgumentException('Options have to be an array');
        $this->options = array();
        foreach($options as $key => $val) {
            if(is_int($key)) {
                $this->options[$val] = array('label' => (string) $val);
            } elseif (!is_array($val)) {
                $this->options[$key] = array('label' => (string) $val);
            } else {
                if (!key_exists('label', $val)) throw new \InvalidArgumentException('If option is given as array, it has to have a "label"-key!');
                $this->options[$key] = $val;
            }
        }
        return $this;
    }


    /**
     * The HTML representation of this element
     *
     * @return string
     */
    public function toHTML() {
        if ($this->attributes['label'] === null) {
            return $this->renderOptions();
        }
        $html = '<optgroup '. buildAttributes($this->attrs()) . '>';

        $html .= $this->renderOptions();
        $html .= '</optgroup>';
        return $html;
    }


    /**
     * @return string
     */
    protected function renderOptions() {
        $html = '';
        foreach($this->options as $key => $val) {
            $selected = ($key == $this->value) ? ' selected="selected"' : '';
            $attrs = '';
            if (is_array($val['attrs'])) {
                array_walk($val['attrs'],function (&$aval, $akey){$aval = hsc($akey).'="'.hsc($aval).'"';});
                $attrs = join(' ', $val['attrs']);
            }
            $html .= '<option' . $selected . ' value="' . hsc($key) . '" '.$attrs.'>' . hsc($val['label']) . '</option>';
        }
        return $html;
    }
}


1			<?php
2
3			namespace dokuwiki\Form;
4
5
6			class OptGroup extends Element {
7			protected $options = array();
8			protected $value;
9
10			/**
11			* @param string $name The name of this form element
12			* @param string $options The available options
13			* @param string $label The label text for this element (will be autoescaped)
			0 ignored issues – show Bug introduced 2016-12-12 15:49 UTC by Report Bug Copy Issue Report There is no parameter named `$label`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
14			*/
15			public function __construct($name, $options) {
16			parent::__construct('optGroup', array('label' => $name));
17			$this->options($options);
			0 ignored issues – show Documentation introduced 2016-12-12 15:49 UTC by Report Bug Copy Issue Report `$options` is of type `string`, but the function expects a `null\|array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
18			}
19
20			/**
21			* Set the element's value
22			*
23			* This is intended to be only called from within @see DropdownElement::val()
24			*
25			* @param string $value
26			* @return bool
27			*/
28			public function setValue($value) {
29			$this->value = $value;
30			return isset($this->options[$value]);
31			}
32
33			/**
34			* Get or set the options of the optgroup
35			*
36			* Options can be given as associative array (value => label) or as an
37			* indexd array (label = value) or as an array of arrays. In the latter
38			* case an element has to look as follows:
39			* option-value => array (
40			* 'label' => option-label,
41			* 'attrs' => array (
42			* attr-key => attr-value, ...
43			* )
44			* )
45			*
46			* @param null\|array $options
47			* @return $this\|array
48			*/
49			public function options($options = null) {
50			if($options === null) return $this->options;
51			if(!is_array($options)) throw new \InvalidArgumentException('Options have to be an array');
52			$this->options = array();
53			foreach($options as $key => $val) {
54			if(is_int($key)) {
55			$this->options[$val] = array('label' => (string) $val);
56			} elseif (!is_array($val)) {
57			$this->options[$key] = array('label' => (string) $val);
58			} else {
59			if (!key_exists('label', $val)) throw new \InvalidArgumentException('If option is given as array, it has to have a "label"-key!');
60			$this->options[$key] = $val;
61			}
62			}
63			return $this;
64			}
65
66
67			/**
68			* The HTML representation of this element
69			*
70			* @return string
71			*/
72			public function toHTML() {
73			if ($this->attributes['label'] === null) {
74			return $this->renderOptions();
75			}
76			$html = '<optgroup '. buildAttributes($this->attrs()) . '>';
			0 ignored issues – show Bug introduced 2016-12-12 15:49 UTC by Report Bug Copy Issue Report It seems like `$this->attrs()` targeting `dokuwiki\Form\Element::attrs()` can also be of type `this<dokuwiki\Form\OptGroup>`; however, `buildAttributes()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
77			$html .= $this->renderOptions();
78			$html .= '</optgroup>';
79			return $html;
80			}
81
82
83			/**
84			* @return string
85			*/
86			protected function renderOptions() {
87			$html = '';
88			foreach($this->options as $key => $val) {
89			$selected = ($key == $this->value) ? ' selected="selected"' : '';
90			$attrs = '';
91			if (is_array($val['attrs'])) {
92			array_walk($val['attrs'],function (&$aval, $akey){$aval = hsc($akey).'="'.hsc($aval).'"';});
93			$attrs = join(' ', $val['attrs']);
94			}
95			$html .= '<option' . $selected . ' value="' . hsc($key) . '" '.$attrs.'>' . hsc($val['label']) . '</option>';
96			}
97			return $html;
98			}
99			}
100

splitbrain / dokuwiki

Push — feature/OptGroups ( aae4de...238a07 )

OptGroup::setValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like