OptGroup::options() - Code Metrics - Inspection of "start of refactoring the config plugin" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2-config ( c6639e )

by Andreas

created 2018-05-11 16:49 UTC

OptGroup::options() C

↳ Parent: OptGroup

Complexity

Conditions	10
Paths	8

Size

Total Lines	23
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	17
nc	8
nop	1
dl	0
loc	23
rs	5.6534
c	0
b	0
f	0

How to fix Complexity

<?php

namespace dokuwiki\Form;


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

    /**
     * @param string $label The label text for this element (will be autoescaped)
     * @param array  $options The available options
     */
    public function __construct($label, $options) {
        parent::__construct('optGroup', array('label' => $label));
        $this->options($options);
    }

    /**
     * Store the given value so it can be used during rendering
     *
     * This is intended to be only called from within @see DropdownElement::val()
     *
     * @param string $value
     * @return bool true if an option with the given value exists, false otherwise
     */
    public function storeValue($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_array($val)) {
                if (!key_exists('label', $val)) throw new \InvalidArgumentException(
                    'If option is given as array, it has to have a "label"-key!'
                );
                if (key_exists('attrs', $val) && is_array($val['attrs']) && key_exists('selected', $val['attrs'])) {
                    throw new \InvalidArgumentException(
                        'Please use function "DropdownElement::val()" to set the selected option'
                    );
                }
                $this->options[$key] = $val;
            } elseif(is_int($key)) {
                $this->options[$val] = array('label' => (string) $val);
            } else {
                $this->options[$key] = array('label' => (string) $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 = ((string)$key === (string)$this->value) ? ' selected="selected"' : '';
            $attrs = '';
            if (!empty($val['attrs']) && is_array($val['attrs'])) {
                $attrs = buildAttributes($val['attrs']);
            }
            $html .= '<option' . $selected . ' value="' . hsc($key) . '" '.$attrs.'>';
            $html .= hsc($val['label']);
            $html .= '</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 $label The label text for this element (will be autoescaped)
12			* @param array $options The available options
13			*/
14			public function __construct($label, $options) {
15			parent::__construct('optGroup', array('label' => $label));
16			$this->options($options);
17			}
18
19			/**
20			* Store the given value so it can be used during rendering
21			*
22			* This is intended to be only called from within @see DropdownElement::val()
23			*
24			* @param string $value
25			* @return bool true if an option with the given value exists, false otherwise
26			*/
27			public function storeValue($value) {
28			$this->value = $value;
29			return isset($this->options[$value]);
30			}
31
32			/**
33			* Get or set the options of the optgroup
34			*
35			* Options can be given as associative array (value => label) or as an
36			* indexd array (label = value) or as an array of arrays. In the latter
37			* case an element has to look as follows:
38			* option-value => array (
39			* 'label' => option-label,
40			* 'attrs' => array (
41			* attr-key => attr-value, ...
42			* )
43			* )
44			*
45			* @param null\|array $options
46			* @return $this\|array
47			*/
48			public function options($options = null) {
49			if($options === null) return $this->options;
50			if(!is_array($options)) throw new \InvalidArgumentException('Options have to be an array');
51			$this->options = array();
52			foreach($options as $key => $val) {
53			if (is_array($val)) {
54			if (!key_exists('label', $val)) throw new \InvalidArgumentException(
55			'If option is given as array, it has to have a "label"-key!'
56			);
57			if (key_exists('attrs', $val) && is_array($val['attrs']) && key_exists('selected', $val['attrs'])) {
58			throw new \InvalidArgumentException(
59			'Please use function "DropdownElement::val()" to set the selected option'
60			);
61			}
62			$this->options[$key] = $val;
63			} elseif(is_int($key)) {
64			$this->options[$val] = array('label' => (string) $val);
65			} else {
66			$this->options[$key] = array('label' => (string) $val);
67			}
68			}
69			return $this;
70			}
71
72
73			/**
74			* The HTML representation of this element
75			*
76			* @return string
77			*/
78			public function toHTML() {
79			if ($this->attributes['label'] === null) {
80			return $this->renderOptions();
81			}
82			$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...
83			$html .= $this->renderOptions();
84			$html .= '</optgroup>';
85			return $html;
86			}
87
88
89			/**
90			* @return string
91			*/
92			protected function renderOptions() {
93			$html = '';
94			foreach($this->options as $key => $val) {
95			$selected = ((string)$key === (string)$this->value) ? ' selected="selected"' : '';
96			$attrs = '';
97			if (!empty($val['attrs']) && is_array($val['attrs'])) {
98			$attrs = buildAttributes($val['attrs']);
99			}
100			$html .= '<option' . $selected . ' value="' . hsc($key) . '" '.$attrs.'>';
101			$html .= hsc($val['label']);
102			$html .= '</option>';
103			}
104			return $html;
105			}
106			}
107

splitbrain / dokuwiki

Push — psr2-config ( c6639e )

OptGroup::options() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like