ntentan\honam\helpers\form\SelectionList

Complexity

Total Complexity

11

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

97.3%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setMultiple()	0	6	1
A	addOption()	0	6	2
A	option()	0	5	1
A	initial()	0	5	1
A	getOptions()	0	4	1
A	render()	0	20	2
A	setOptions()	0	9	2

<?php
/**
 * Selection Lists for forms
 * 
 * Ntentan Framework
 * Copyright (c) 2008-2012 James Ekow Abaka Ainooson
 * 
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 * 
 * @author James Ainooson <jainooson@gmail.com>
 * @copyright Copyright 2010 James Ekow Abaka Ainooson
 * @license MIT
 */


namespace ntentan\honam\helpers\form;

/**
 * A selection list class for the forms helper. This class renders an HTML
 * select form object with its associated options.
 */
class SelectionList extends Field
{
    /**
     * An array of options to display with this selection list
     * @var array
     */
    protected $options = array();

    /**
     * When set true, this selection list would allow multiple selections
     * @var boolean
     */
    protected $multiple;
    
    protected $default;

    /**
     * Constructs a new selection list. This constructor could be invoked through
     * the form helper's $this->form->get_* method as $this->form->get_selection_list().
     *
     * @param string $label The label for the selection list
     * @param string $name The name of the selection list
     * @param string $description A brief description for the selection list
     */
    public function __construct($label="", $name="", $description="")
    {
        Field::__construct($name);
        Element::__construct($label, $description);
    }

    /**
     * Sets whether multiple selections are allowed. This method automatically
     * appends the array symbol '[]' to the name of the selection list object.
     * @param boolean $multiple
     * @return SelectionList
     */
    public function setMultiple($multiple)
    {
        $this->name.="[]";
        $this->multiple = $multiple;
        return $this;
    }

    /**
     * Add an option to the selection list.
     * @param string $label
     * @param string $value
     * @return SelectionList
     */
    public function addOption($label="", $value="")
    {
        if($value==="") $value=$label;
        $this->options[$value] = $label;
        return $this;
    }

    /**
     * An alias for SelectionList::addOption
     * @param string $label
     * @param string $value
     * @return SelectionList
     */
    public function option($label='', $value='')
    {
        $this->addOption($label, $value);
        return $this;
    }
    
    public function initial($default)
    {
        $this->default = $default;
        return $this;
    }

    public function render()
    {
        $keys = array_keys($this->options);
        array_unshift($keys, '');
        array_unshift($this->options, $this->default);
        $this->options = array_combine($keys, $this->options);
        
        $this->setAttribute('name', $this->name);
        
        if($this->multiple)
        {
            $this->setAttribute('multiple', 'multiple');
        }
        $this->setAttribute('class', "select {$this->getCSSClasses()}");
        
        return \ntentan\honam\TemplateEngine::render(
            'select_element.tpl.php', 
            array('element' => $this)
        );
    }

    /**
     * Set the options using a key value pair datastructure represented in the form of
     * a structured array.
     *
     * @param array $options An array of options
     * 
     * @return SelectionList
     */
    public function setOptions($options = [])
    {
        if(is_a($options, "\\ntentan\\honam\\template_engines\\php\\Variable"))
        {
            $options = $options->unescape();

The method unescape cannot be called on $options (of type array).

        }
        $this->options += $options;
        return $this;
    }

    /**
     * Return the array of options
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }
}