File builder/form/field/FormFieldTextEditor.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: 

<?php
/**
 * This class manage single-line text fields.
 * @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: 2018 06 03
 * @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 FormFieldTextEditor extends AbstractFormField
{
    protected $type = 'text';
    protected $size = 30;
    protected $maxlength = 255;

    /**
     * Constructs a FormFieldTextEditor.
     * It has these options in addition to the AbstractFormField ones:
     * <ul>
     *  <li>size: The size (width) of the HTML field</li>
     *  <li>maxlength: The maximum length for the field</li>
     * </ul>
     * @param string $id Field identifier
     * @param string $label Field label
     * @param string $value Default value
     * @param string[] $field_options Map containing the options
     * @param FormFieldConstraint[] $constraints The constraints checked during the validation
     */
    public function __construct($id, $label, $value, array $field_options = array(), array $constraints = array())
    {
        parent::__construct($id, $label, $value, $field_options, $constraints);
        $this->set_css_form_field_class('form-field-text');
    }

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

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

        $field->put_all(array(
            'SIZE' => $this->size,
            'MAX_LENGTH' => $this->maxlength,
            'NAME' => $this->get_html_id(),
            'ID' => $this->get_id(),
            'HTML_ID' => $this->get_html_id(),
            'TYPE' => $this->type,
            'VALUE' => $this->get_value(),
            'CLASS' => $this->get_css_class(),
            'C_DISABLED' => $this->is_disabled(),
            'C_READONLY' => $this->is_readonly(),
            'C_PATTERN' => $this->has_pattern(),
            'PATTERN' => $this->pattern,
            'C_PLACEHOLDER' => $this->has_placeholder(),
            'PLACEHOLDER' => $this->placeholder
        ));

        $this->assign_common_template_variables($template);

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

        return $template;
    }

    protected function compute_options(array &$field_options)
    {
        foreach ($field_options as $attribute => $value)
        {
            $attribute = TextHelper::strtolower($attribute);
            switch ($attribute)
            {
                case 'size':
                    $this->size = $value;
                    unset($field_options['size']);
                    break;
                case 'maxlength':
                    $this->maxlength = $value;
                    unset($field_options['maxlength']);
                    break;
            }
        }
        parent::compute_options($field_options);
    }

    /**
     * {@inheritdoc}
     */
    public function get_value()
    {
        return TextHelper::substr($this->value, 0, $this->maxlength);
    }

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