form_question_type_select.inc

<?php
require_once dirname(__FILE__).'/../../form_question/form_question.inc';
require_once SQ_FUDGE_PATH.'/csv/csv.inc';


class Form_Question_Type_Select extends Form_Question
{


    function Form_Question_Type_Select($assetid=0,$data=Array())
    {
        $this->Form_Question($assetid,$data);

    }//end constructor


    function getAllowedRules()
    {
        return Array('select_limit', 'selection');

    }//end getAllowedRules()


    function _getAllowedLinks()
    {
        return Array();

    }//end _getAllowedLinks()


    function getHtmlField()
    {
        $name = 'q'.$this->id;

        // prepare a valid value for the field id
        $extras = 'id="'.str_replace(':', '_', $name).'" '.$this->attr('extra');

        if ($this->attr('tabindex')) {
            $extras .= ' tabindex="'.$this->attr('tabindex').'"';
        }

        ob_start();
        combo_box($name, $this->getOptions(), $this->attr('multiple'), $this->getValue(), $this->attr('height'), $extras);
        $html = ob_get_contents();
        ob_end_clean();

        return $html;

    }//end getHtmlField()


    function getOptions()
    {
        $options = $this->attr('options');

        if (count($options) > 0) {
            $decoded_options = Array();
            // remove empty options
            foreach (array_keys($options) as $k) {
                if ($options[$k] != '') {
                    $decoded_options[html_entity_decode($k, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET)] = html_entity_decode($options[$k], ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET);
                }
            }
            $options = $decoded_options;

            // if allow empty is true, add the '-- Leave Empty --' as the first option
            if ($this->attr('allow_empty')) {
                if(array_key_exists(html_entity_decode($this->attr('empty_key'), ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET), $options)) {
                    trigger_localised_error('CORE0302', E_USER_NOTICE);
                } else {
                    $empty = Array(html_entity_decode($this->attr('empty_key'), ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET) => html_entity_decode($this->attr('empty_text'), ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET));
                    $options = $empty + $options;
                }
            }
        }

        return $options;

    }//end getOptions()


    function getSummary($answer=NULL)
    {
        if (is_null($answer)) $answer = $this->value;

        if (is_array($answer)) {
            $ans_str = Array();
            foreach ($answer as $a) {
                // if the option is '-- Leave Empty --', we should return empty string
                $answer_by_offset = $this->getAnswerByOffset($a);
                if ($answer_by_offset != $this->attr('empty_text')) {
                    $ans_str[] = $this->getAnswerByOffset($a);
                } else {
                    $ans_str[] = '';
                }
            }
            return implode(', ', $ans_str);
        }

        // if the option is '-- Leave Empty --', we should return empty string
        $answer_by_offset = $this->getAnswerByOffset($answer);
        if ($answer_by_offset != $this->attr('empty_text')) {
            return $this->getAnswerByOffset($answer);
        } else {
            return '';
        }

    }//end getSummary()


    function getXML($answer)
    {
        ob_start();

        echo '<select_q id="'.addslashes($this->id).'"  name="'.htmlentities($this->attr('name'), ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET).'">';
        if (!is_array($answer)) $answer = Array($answer);

        foreach ($answer as $a) {
            echo '<option value="'.$a.'">'.htmlentities($this->getAnswerByOffset($a), ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET).'</option>';
        }
        echo '</select_q>';

        $contents = ob_get_contents();
        ob_end_clean();

        return $contents;

    }//end getXML()


    function isSelected($option)
    {
        $options = $this->getValue();
        if (!is_array($options)) {
            $options = Array($options);
        }

        return in_array($option, $options);

    }//end isSelected()


    function isEmptyOption($option)
    {
    $option_name = $this->getAnswerByOffset($option);
        return $option_name == $this->attr('empty_text');

    }//end isEmptyOption()


    function getOptionName($option_code)
    {
        return $this->getAnswerByOffset($option_code);

    }//end getOptionName()


    public function importOptionsFromCSV($filename)
    {
        $csv = new CSV($filename);
        $csv->import();

        $values = $csv->values;
        $options = Array();
        $defaults = Array();

        if (!empty($values)) {
            // We will assume that the number of columns in the first row
            // is representative of the entire list
            $num_columns = count($values[0]);
            $index = 0;

            foreach ($values as $row) {
                if ($num_columns === 1) {
                    // If we haven't provided a first column, then key and value
                    // are the same
                    $value = htmlentities($row[0], ENT_NOQUOTES, SQ_CONF_DEFAULT_CHARACTER_SET);
                    $options[$index] = $value;
                    $index++;
                } else {
                    $key = htmlentities($row[0], ENT_NOQUOTES, SQ_CONF_DEFAULT_CHARACTER_SET);
                    $value = htmlentities($row[1], ENT_NOQUOTES, SQ_CONF_DEFAULT_CHARACTER_SET);
                    $options[$key] = $value;

                    if ($num_columns === 3) {
                        if ($row[2] == 1) {
                            $defaults[] = $key;
                        }
                    }
                }
            }

            $this->setAttrValue('options', $options);
            if ($num_columns === 3) {
                if (!$this->attr('multiple')) {
                    if (count($defaults) > 1) {
                        trigger_localised_error('CORE0286', E_USER_NOTICE);
                    }
                    if (count($defaults) > 0) {
                        $defaults = Array($defaults[0]);
                    } else {
                        $defaults = Array();
                    }
                }

                $this->setAttrValue('default', $defaults);
            } else {
                // What happens if it gets overwritten?
                $current_default = $this->attr('default');
                if (!is_array($current_default)) {
                    $current_default = Array($current_default);
                }
                foreach ($current_default as $default_key) {
                    // Remove any default options that are not choices in this
                    // particular situation
                    if (!isset($options[$default_key])) {
                        unset($current_default[$default_key]);
                    }
                }
                $this->setAttrValue('default', $current_default);
            }
            $this->saveAttributes();
        }

    }//end importOptionsFromCSV()


}//end class
?>