Classes

File builder/form/field/FormFieldSimpleSelectChoice.class.php

File builder/form/field/FormFieldSimpleSelectChoice.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 
<?php
/**
 * This class manage select fields.
 * It provides you additionnal field options :
 * <ul>
 *  <li>multiple : Type of select field, mutiple allow you to check several options.</li>
 * </ul>
 * @package     Builder
 * @subpackage  Form\field
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Regis VIARRE <crowkait@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2017 03 10
 * @since       PHPBoost 2.0 - 2009 04 28
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
 * @contributor Arnaud GENET <elenwii@phpboost.com>
 * @contributor mipel <mipel@phpboost.com>
*/

class FormFieldSimpleSelectChoice extends AbstractFormFieldChoice
{
    private $default_value;

    /**
     * Constructs a FormFieldSimpleSelectChoice.
     * @param string $id Field id
     * @param string $label Field label
     * @param mixed $value Default value (either a FormFieldEnumOption object or a string corresponding to the FormFieldEnumOption's raw value)
     * @param FormFieldEnumOption[] $options Enumeration of the possible values
     * @param string[] $field_options Map of the field options (this field has no specific option, there are only the inherited ones)
     * @param FormFieldConstraint List of the constraints
     */
    public function __construct($id, $label, $value, array $options, array $field_options = array(), array $constraints = array())
    {
        $this->default_value = $value;
        parent::__construct($id, $label, $value, $options, $field_options, $constraints);
        $this->set_css_form_field_class('form-field-select');
    }

    /**
     * @return string The html code for the select.
     */
    public function display()
    {
        $template = $this->get_template_to_use();

        $this->assign_common_template_variables($template);

        $template->assign_block_vars('fieldelements', array(
            'ELEMENT' => $this->get_html_code()->render(),
        ));

        return $template;
    }

    private function get_html_code()
    {

        $tpl = new FileTemplate('framework/builder/form/fieldelements/FormFieldSimpleSelectChoice.tpl');

        $tpl->put_all(array(
            'NAME' => $this->get_html_id(),
            'ID' => $this->get_id(),
            'HTML_ID' => $this->get_html_id(),
            'CSS_CLASS' => $this->get_css_class(),
            'C_DISABLED' => $this->is_disabled()
        ));

        foreach ($this->get_options() as $option)
        {
            $tpl->assign_block_vars('options', array(), array(
                'OPTION' => $option->display()
            ));
        }

        return $tpl;
    }

    protected function get_option($raw_value)
    {
        foreach ($this->get_options() as $option)
        {
            $result = $option->get_option($raw_value);
            if ($result !== null)
            {
                return $result;
            }
        }
        return null;
    }

    protected function assign_common_template_variables(Template $template)
    {
        parent::assign_common_template_variables($template);
        $template->put('C_REQUIRED_AND_HAS_VALUE', $this->is_required() && $this->default_value);
    }

    protected function get_default_template()
    {
        return new FileTemplate('framework/builder/form/FormField.tpl');
    }

    protected function get_js_specialization_code()
    {
        return ($this->is_required() ? '
        jQuery("#'. $this->get_html_id() .'_field").change(function() {
            HTMLForms.get("' . $this->get_form_id() . '").getField("'. $this->get_id() . '").enableValidationMessage();
            HTMLForms.get("' . $this->get_form_id() . '").getField("'. $this->get_id() . '").liveValidate();
        });' : '');
    }
}
?>