DropdownElement::mainElementHTML() - Code Metrics - Inspection of "Merge branch 'remoteapiGetversions' of github.com:..." - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — remoteapiGetversions ( b2f4ab...f28a57 )

by Gerrit

created 2016-05-18 22:23 UTC

DropdownElement::mainElementHTML() B

↳ Parent: DropdownElement

Complexity

Conditions	5
Paths	10

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	1

Metric	Value
cc	5
eloc	12
c	3
b	1
f	1
nc	10
nop	0
dl	0
loc	17
rs	8.8571

<?php
namespace dokuwiki\Form;

/**
 * Class DropdownElement
 *
 * Represents a HTML select. Please note that this does not support multiple selected options!
 *
 * @package dokuwiki\Form
 */
class DropdownElement extends InputElement {

    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)
     */
    public function __construct($name, $options, $label = '') {
        parent::__construct('dropdown', $name, $label);
        $this->options($options);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * Get or set the options of the Dropdown
     *
     * 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;
            }
        }
        $this->val(''); // set default value (empty or first)
        return $this;
    }

    /**
     * Gets or sets an attribute
     *
     * When no $value is given, the current content of the attribute is returned.
     * An empty string is returned for unset attributes.
     *
     * When a $value is given, the content is set to that value and the Element
     * itself is returned for easy chaining
     *
     * @param string $name Name of the attribute to access
     * @param null|string $value New value to set
     * @return string|$this
     */
    public function attr($name, $value = null) {
        if(strtolower($name) == 'multiple') {
            throw new \InvalidArgumentException('Sorry, the dropdown element does not support the "multiple" attribute');
        }
        return parent::attr($name, $value);
    }

    /**
     * Get or set the current value
     *
     * When setting a value that is not defined in the options, the value is ignored
     * and the first option's value is selected instead
     *
     * @param null|string $value The value to set
     * @return $this|string
     */
    public function val($value = null) {
        if($value === null) return $this->value;

        if(isset($this->options[$value])) {
            $this->value = $value;
        } else {
            // unknown value set, select first option instead
            $keys = array_keys($this->options);
            $this->value = (string) array_shift($keys);
        }

        return $this;
    }

    /**
     * Create the HTML for the select it self
     *
     * @return string
     */
    protected function mainElementHTML() {
        if($this->useInput) $this->prefillInput();

        $html = '<select ' . buildAttributes($this->attrs()) . '>';

        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>';
        }
        $html .= '</select>';

        return $html;
    }

}


1			<?php
2			namespace dokuwiki\Form;
3
4			/**
5			* Class DropdownElement
6			*
7			* Represents a HTML select. Please note that this does not support multiple selected options!
8			*
9			* @package dokuwiki\Form
10			*/
11			class DropdownElement extends InputElement {
12
13			protected $options = array();
14
15			protected $value = '';
16
17			/**
18			* @param string $name The name of this form element
19			* @param string $options The available options
20			* @param string $label The label text for this element (will be autoescaped)
21			*/
22			public function __construct($name, $options, $label = '') {
23			parent::__construct('dropdown', $name, $label);
24			$this->options($options);
			0 ignored issues – show Documentation introduced 2016-04-15 10:04 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...
25			}
26
27			/**
28			* Get or set the options of the Dropdown
29			*
30			* Options can be given as associative array (value => label) or as an
31			* indexd array (label = value) or as an array of arrays. In the latter
32			* case an element has to look as follows:
33			* option-value => array (
34			* 'label' => option-label,
35			* 'attrs' => array (
36			* attr-key => attr-value, ...
37			* )
38			* )
39			*
40			* @param null\|array $options
41			* @return $this\|array
42			*/
43			public function options($options = null) {
44			if($options === null) return $this->options;
45			if(!is_array($options)) throw new \InvalidArgumentException('Options have to be an array');
46			$this->options = array();
47
48			foreach($options as $key => $val) {
49			if(is_int($key)) {
50			$this->options[$val] = array('label' => (string) $val);
51			} elseif (!is_array($val)) {
52			$this->options[$key] = array('label' => (string) $val);
53			} else {
54			if (!key_exists('label', $val)) throw new \InvalidArgumentException('If option is given as array, it has to have a "label"-key!');
55			$this->options[$key] = $val;
56			}
57			}
58			$this->val(''); // set default value (empty or first)
59			return $this;
60			}
61
62			/**
63			* Gets or sets an attribute
64			*
65			* When no $value is given, the current content of the attribute is returned.
66			* An empty string is returned for unset attributes.
67			*
68			* When a $value is given, the content is set to that value and the Element
69			* itself is returned for easy chaining
70			*
71			* @param string $name Name of the attribute to access
72			* @param null\|string $value New value to set
73			* @return string\|$this
74			*/
75			public function attr($name, $value = null) {
76			if(strtolower($name) == 'multiple') {
77			throw new \InvalidArgumentException('Sorry, the dropdown element does not support the "multiple" attribute');
78			}
79			return parent::attr($name, $value);
80			}
81
82			/**
83			* Get or set the current value
84			*
85			* When setting a value that is not defined in the options, the value is ignored
86			* and the first option's value is selected instead
87			*
88			* @param null\|string $value The value to set
89			* @return $this\|string
90			*/
91			public function val($value = null) {
92			if($value === null) return $this->value;
93
94			if(isset($this->options[$value])) {
95			$this->value = $value;
96			} else {
97			// unknown value set, select first option instead
98			$keys = array_keys($this->options);
99			$this->value = (string) array_shift($keys);
100			}
101
102			return $this;
103			}
104
105			/**
106			* Create the HTML for the select it self
107			*
108			* @return string
109			*/
110			protected function mainElementHTML() {
111			if($this->useInput) $this->prefillInput();
112
113			$html = '<select ' . buildAttributes($this->attrs()) . '>';
			0 ignored issues – show Bug introduced 2016-04-15 10:04 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\DropdownElement>`; 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...
114			foreach($this->options as $key => $val) {
115			$selected = ($key == $this->value) ? ' selected="selected"' : '';
116			$attrs = '';
117			if (is_array($val['attrs'])) {
118			array_walk($val['attrs'],function (&$aval, $akey){$aval = hsc($akey).'="'.hsc($aval).'"';});
119			$attrs = join(' ', $val['attrs']);
120			}
121			$html .= '<option' . $selected . ' value="' . hsc($key) . '" '.$attrs.'>' . hsc($val['label']) . '</option>';
122			}
123			$html .= '</select>';
124
125			return $html;
126			}
127
128			}
129

splitbrain / dokuwiki

Push — remoteapiGetversions ( b2f4ab...f28a57 )

DropdownElement::mainElementHTML() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like