Koch\Form\Elements\Select

Complexity

Total Complexity

19

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setOptions()	0	11	2
A	setSize()	0	6	1
A	setDefaultValue()	0	6	1
A	withValuesAsKeys()	0	6	1
C	render()	0	47	10
A	renderOptionTag()	0	19	3

<?php

/**
 * Koch Framework
 * Jens-André Koch © 2005 - onwards.
 *
 * This file is part of "Koch Framework".
 *
 * License: GNU/GPL v2 or any later version, see LICENSE file.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace Koch\Form\Elements;

use Koch\Form\FormElement;
use Koch\Form\FormElementInterface;

/**
 *
 */
class Select extends FormElement implements FormElementInterface
{
    /**
     * @var array array with options for the dropdown
     */
    public $options;

    /**
     * @var string name of the default option of the select dropdown (pre-selection)
     */
    public $default;

    /**
     * @var string description
     */
    public $description;

    /**
     * 0 = pure dropdown with 1 field
     * 3 = 3 elements shown, rest available via scrollbar.
     *
     * @var int number of displayed items
     */
    public $size;

    public $withValuesAsKeys;

    /**
     * @var string Label
     */
    #public $label ='Select an item from this pull-down menu.';

58% of this comment could be valid code. Did you maybe forget this after debugging?

    public function __construct()
    {
        $this->type = 'select';
    }

    /**
     * Sets the array with options for the dropdown element.
     *
     * @param array $options
     * @param bool  $addSelectText Adds " - Select -" as first entry to the options array.
     *
     * @return Select
     */
    public function setOptions($options, $addSelectText = true)
    {
        if ($addSelectText === true) {
            // add one entry on top for the dropdown
            array_unshift($options, _('Select...'));
        }

        $this->options = $options;

        return $this;
    }

    public function setSize($size)
    {
        $this->size = $size;

        return $this;
    }

    /**
     * This sets the default value.
     * Value is used to mark that option as "selected".
     */
    public function setDefaultValue($default)
    {
        $this->default = $default;

        return $this;
    }

    /**
     * Render option tags with value => value relation.
     *
     * <option value="' . $value. '">' . $value . '</option>
     *
     * and not as a key => value relation
     *
     * <option value="' . $key . '">' . $value . '</option>
     *
     * This makes it a bit easier to pass actual values around via POST,
     * instead of passing the numeric index for lookup.
     *
     * @return Select \Koch\Form\Element\Select
     */
    public function withValuesAsKeys()
    {
        $this->withValuesAsKeys = true;

        return $this;
    }

    public function render()
    {
        // open the html select tag
        $html = '';
        $html .= '<select ';
        $html .= (bool) $this->name ? 'name="' . $this->name . '"' : null;
        $html .= (bool) $this->id ? 'id="' . $this->id . '"' : null;
        $html .= (bool) $this->class ? 'class="' . $this->class . '"' : null;
        $html .= (bool) $this->size ? 'size="' . $this->size . '"' : null;
        $html .= '>';

        /**
         * This handles the default value setting via the options array key "selected".
         * It grabs the first element in the options array, which keyname should be 'selected'
         * and then removes it, setting its value to $this->default.
         *
         * The check for empty($this->default) is important, because the default value might already
         * be set via setDefaultValue(). Such a scenario is given, when the form is generated via array.
         * The array would contain options['selected'] with an default value, but the actual default
         * value is incomming via setDefaultValue().
         *
         * Note: If the options array is incomming via a formgenerator: the generator has already performed this step!
         * $this->setDefault(options['selected']);
         */
        if ($this->options['selected'] !== null and empty($this->default)) {

Using logical operators such as and instead of && is generally not recommended.

            $this->default = $this->options['selected'];
            unset($this->options['selected']);
        }

        if (empty($this->options) === false) {
            // loop over all selectfield options
            foreach ($this->options as $key => $value) {
                if ($this->withValuesAsKeys === true) {
                    $html .= $this->renderOptionTag($value, $value);
                } else {
                    $html .= $this->renderOptionTag($key, $value);
                }
            }
        } else {
            $html .= '<option value="0">No Options given.</option>';
        }

        // close the html select tag
        $html .= '</select>';

        return $html;
    }

    private function renderOptionTag($key, $value)
    {
        /*
         * the addSelectText would be posted as value.
         * in order to be able to use empty() on the incomming post array variables,
         * we need to remove it. this makes it just a select helper, without data.
         */
        if ($key === 'Select...') {
            $key = '';
        }

        // check if the value is the default one and in case it is, add html "selected"
        if ($key === $this->default) {
            return '<option value="' . $key . '" selected="selected">' . $value . '</option>';
        } else { // a normal select element is rendered

            return '<option value="' . $key . '">' . $value . '</option>';
        }
    }
}