Classes

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

File builder/form/field/AbstractFormField.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: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 
<?php
/**
 * Abstract class that proposes a default implementation for the FormField interface.
 *
 * @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      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2018 05 31
 * @since       PHPBoost 3.0 - 2010 01 08
 * @contributor Julien BRISWALTER <j1.seth@phpboost.com>
 * @contributor Arnaud GENET <elenwii@phpboost.com>
*/

abstract class AbstractFormField implements FormField
{
    /**
     * @var string
     */
    protected $id = '';
    /**
     * @var string
     */
    private $form_id = '';
    /**
     * @var string
     */
    private $fieldset_id = '';
    /**
     * @var string
     */
    protected $label = '';
    /**
     * @var string
     */
    protected $description = '';
    /**
     * @var string
     */
    protected $value = null;
    /**
     * @var boolean
     */
    protected $disabled = false;
    /**
     * @var boolean
     */
    protected $hidden = false;
    /**
     * @var boolean
     */
    protected $readonly = false;
    /**
     * @var string
     */
    protected $css_class = '';
    /**
     * @var string
     */
    protected $css_field_class = '';
    /**
     * @var string
     */
    protected $css_form_field_class = '';
    /**
     * @var string
     */
    protected $required = false;
    /**
     * @var string
     */
    protected $pattern = '';
    /**
     * @var string
     */
    protected $placeholder = '';
    /**
     * @var string
     */
    protected $validation_error_message = '';
    /**
     * @var FormFieldConstraint[]
     */
    protected $constraints = array();
    /**
     * @var FormConstraint[]
     */
    protected $form_constraints = array();
    /**
     * @var Template
     */
    protected $template = null;

    /**
     * @var string[string]
     */
    protected $events = array();

    /**
     * Constructs and set parameters to the field.
     * The specific parameters of this abstract class (common with many fields) are the following:
     * <ul>
     *  <li>description at which you must associate the description of the field</li>
     *  <li>class which corresponds to the HTML class of the field</li>
     *  <li>required which tells whether this field must be completed. If it's the case, it will display a * beside the label and will add a non empty constraint to the constraints.</li>
     * </ul>
     * None of these parameters is required.
     * @param string $id Field identifier
     * @param string $label Field label
     * @param mixed $value Field value
     * @param string[] $field_options Map associating the parameters values to the parameters names.
     * @param FormFieldConstraint[] $constraints List of the constraints which must be checked when the form is been validated
     */
    protected function __construct($id, $label, $value, array $field_options = array(), array $constraints = array())
    {
        $this->set_id($id);
        $this->set_label($label);
        $this->set_value($value);
        $this->compute_options($field_options);
        $this->set_css_field_class($this->get_css_class());

        foreach ($constraints as $constraint)
        {
            if (!empty($constraint))
            {
                $this->add_constraint($constraint);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function get_id()
    {
        return $this->id;
    }

    /**
     * {@inheritdoc}
     */
    public function set_id($id)
    {
        $this->id = $id;
    }

    /**
     * {@inheritdoc}
     */
    public function get_form_id()
    {
        return $this->form_id;
    }

    /**
     * {@inheritdoc}
     */
    public function set_form_id($form_id)
    {
        $this->form_id = $form_id;
    }

    public function set_fieldset_id($fieldset_id)
    {
        $this->fieldset_id = $fieldset_id;
    }

    /**
     * Returns the label
     * @return string The label
     */
    public function get_label()
    {
        return $this->label;
    }

    /**
     * Sets the label
     * @param string $label The label
     */
    public function set_label($label)
    {
        $this->label = $label;
    }

    /**
     * Returns the description
     * @return string the description
     */
    public function get_description()
    {
        return $this->description;
    }

    /**
     * Sets the description
     * @param string $description The description
     */
    public function set_description($description)
    {
        $this->description = $description;
    }

    /**
     * {@inheritdoc}
     */
    public function get_value()
    {
        return $this->value;
    }

    /**
     * {@inheritdoc}
     */
    public function set_value($value)
    {
        $this->value = $value;
    }

    /**
     * Tells whether the field is required
     * @return true if it is, false otherwise
     */
    public function is_required()
    {
        return $this->required;
    }

    /**
     * Changes the fact that the field is required or not.
     * @param bool $required true if it's required, false otherwise
     */
    public function set_required($required)
    {
        $this->required = $required;
    }

    /**
     * {@inheritdoc}
     */
    public function validate()
    {
        if ($this->is_disabled())
        {
            return true;
        }
        $this->retrieve_value();
        foreach ($this->constraints as $constraint)
        {
            if (!$constraint->validate($this))
            {
                $validation_error_message = $constraint->get_validation_error_message();
                if (!empty($validation_error_message))
                {
                    $this->validation_error_message = $this->get_label() . ' : ' . $validation_error_message;
                }
                return false;
            }
        }
        foreach ($this->form_constraints as $constraint)
        {
            if (!$constraint->validate($this))
            {
                $validation_error_message = $constraint->get_validation_error_message();
                if (!empty($validation_error_message))
                {
                    $this->validation_error_message = $this->get_label() . ' : ' . $validation_error_message;
                }
                return false;
            }
        }
        return true;
    }

    public function get_validation_error_message()
    {
        return $this->validation_error_message;
    }

    public function set_validation_error_message($error_message)
    {
        $this->validation_error_message = $error_message;
    }

    /**
     * {@inheritdoc}
     */
    public function retrieve_value()
    {
        $request = AppContext::get_request();
        if ($request->has_parameter($this->get_html_id()))
        {
            $this->set_value($request->get_string($this->get_html_id()));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function get_html_id()
    {
        return $this->form_id . '_' . $this->get_id();
    }

    /**
     * {@inheritdoc}
     */
    public function add_constraint(FormFieldConstraint $constraint)
    {
        $this->constraints[] = $constraint;
    }

    public function add_form_constraint(FormConstraint $constraint)
    {
        $this->form_constraints[] = $constraint;
    }

    /**
     * {@inheritdoc}
     */
    public function has_constraints()
    {
        return (count($this->constraints) > 0 || count($this->form_constraints) > 0);
    }

    public function get_js_validations()
    {
        $validations = array();
        foreach ($this->constraints as $constraint)
        {
            $validation = $constraint->get_js_validation($this);
            if (!empty($validation))
            {
                $validations[] = $validation;
            }
        }
        foreach ($this->form_constraints as $constraint)
        {
            $validation = $constraint->get_js_validation();
            if (!empty($validation))
            {
                $validations[] = $validation;
            }
        }
        return $validations;
    }

    public function get_onblur_validation()
    {
        return 'formFieldConstraintsOnblurValidation(this, Array(' .
        implode(",", $this->get_js_validations()) . '));';
    }

    public function add_event($event, $handler)
    {
        $this->events[$event] = $handler;
    }

    protected function compute_options(array &$field_options)
    {
        foreach($field_options as $attribute => $value)
        {
            $attribute = TextHelper::strtolower($attribute);
            switch ($attribute)
            {
                case 'description':
                    $this->set_description($value);
                    unset($field_options['description']);
                    break;
                case 'disabled':
                    $this->set_disabled($value);
                    unset($field_options['disabled']);
                    break;
                case 'readonly':
                    $this->set_readonly($value);
                    unset($field_options['readonly']);
                    break;
                case 'class':
                    $this->set_css_class($value);
                    unset($field_options['class']);
                    break;
                case 'field_class':
                    $this->set_css_field_class($value);
                    unset($field_options['field_class']);
                    break;
                case 'form_field_class':
                    $this->set_css_form_field_class($value);
                    unset($field_options['form_field_class']);
                    break;
                case 'events':
                    $this->events = $value;
                    unset($field_options['events']);
                    break;
                case 'hidden':
                    $this->set_hidden($value);
                    unset($field_options['hidden']);
                    break;
                case 'pattern':
                    $this->set_pattern($value);
                    unset($field_options['pattern']);
                    break;
                case 'placeholder':
                    $this->set_placeholder($value);
                    unset($field_options['placeholder']);
                    break;
                case 'required':
                    if (is_string($value))
                    {
                        $this->set_required(true);
                        $this->add_constraint(new FormFieldConstraintNotEmpty($value, $value));
                    }
                    elseif (is_bool($value) && $value === true)
                    {
                        $this->set_required(true);
                        $this->add_constraint(new FormFieldConstraintNotEmpty());
                    }
                    unset($field_options['required']);
                    break;
                default :
                    throw new FormBuilderException('The class ' . get_class($this) . ' hasn\'t the ' . $attribute . ' attribute');
            }
        }
    }

    protected function assign_common_template_variables(Template $template)
    {
        $has_js_validations = false;
        $js_tpl = new FileTemplate('framework/builder/form/AddFieldJS.tpl');

        foreach ($this->get_related_fields() as $field)
        {
            $js_tpl->assign_block_vars('related_field', array(
                'ID' => $field
            ));
            $has_js_validations = true;
        }

        foreach ($this->events as $event => $handler)
        {
            $js_tpl->assign_block_vars('event_handler', array(
                'EVENT' => $event,
                'HANDLER' => $handler
            ));
            $has_js_validations = true;
        }

        foreach ($this->get_js_validations() as $constraint)
        {
            $js_tpl->assign_block_vars('constraint', array(
                'CONSTRAINT' => $constraint
            ));
            $has_js_validations = true;
        }

        $js_tpl->put_all(array(
            'C_DISABLED' => $this->is_disabled(),
            'C_HAS_CONSTRAINTS' => $this->has_constraints(),
            'ID' => $this->get_id(),
            'HTML_ID' => $this->get_html_id(),
            'JS_SPECIALIZATION_CODE' => $this->get_js_specialization_code(),
            'FORM_ID' => $this->form_id,
            'FIELDSET_ID' => $this->fieldset_id
        ));

        $template->put('ADD_FIELD_JS', $js_tpl);

        $description = $this->get_description();
        $template->put_all(array(
            'ID' => $this->get_id(),
            'HTML_ID' => $this->get_html_id(),
            'NAME' => $this->get_html_id(),
            'LABEL' => $this->get_label(),
            'DESCRIPTION' => $description,
            'C_DESCRIPTION' => !empty($description),
            'C_REQUIRED' => $this->is_required(),
            'C_REQUIRED_AND_HAS_VALUE' => $this->is_required() && (!empty($this->value) || $this->value == '0'),
            'VALUE' => $this->get_value(),
            'C_HAS_CONSTRAINTS' => $this->has_constraints(),
            'CSS_CLASS' => $this->get_css_class(),
            'C_HAS_CSS_CLASS' => $this->get_css_class() != '',
            'FIELD_CLASS' => $this->get_css_field_class(),
            'C_HAS_FIELD_CLASS' => $this->get_css_field_class() != '',
            'FORM_FIELD_CLASS' => $this->get_css_form_field_class(),
            'C_HAS_FORM_FIELD_CLASS' => $this->get_css_form_field_class() != '',
            'FORM_ID' => $this->form_id,
            'FIELDSET_ID' => $this->fieldset_id,
            'C_HAS_LABEL' => !empty($description) || $this->get_label() != '',
            'C_DISABLED' => $this->is_disabled(),
            'C_READONLY' => $this->is_readonly(),
            'C_HIDDEN' => $this->is_hidden(),
            'C_PATTERN' => $this->has_pattern(),
            'PATTERN' => $this->pattern,
            'C_PLACEHOLDER' => $this->has_placeholder(),
            'PLACEHOLDER' => $this->placeholder
        ));
    }

    private function get_related_fields()
    {
        $related_fields = array();
        foreach ($this->form_constraints as $constraint)
        {
            foreach ($constraint->get_related_fields() as $field)
            {
                if ($field->get_id() != $this->get_id() && !in_array($field->get_id(), $related_fields))
                {
                    $related_fields[] = $field->get_id();
                }
            }
        }
        return $related_fields;
    }

    protected function get_css_class()
    {
        return $this->css_class;
    }

    protected function set_css_class($css_class)
    {
        $this->css_class = $css_class;
    }

    protected function get_css_field_class()
    {
        return $this->css_field_class;
    }


    protected function set_css_field_class($css_field_class)
    {
        $this->css_field_class = $css_field_class;
    }

    protected function get_css_form_field_class()
    {
        return $this->css_form_field_class;
    }


    protected function set_css_form_field_class($css_form_field_class)
    {
        $this->css_form_field_class = $css_form_field_class;
    }

    public function is_disabled()
    {
        return $this->disabled;
    }

    public function disable()
    {
        $this->set_disabled(true);
    }

    public function enable()
    {
        $this->set_disabled(false);
    }

    protected function set_disabled($disabled)
    {
        $this->disabled = $disabled;
    }

    public function is_readonly()
    {
        return $this->readonly;
    }

    public function set_readonly($readonly)
    {
        $this->readonly = $readonly;
    }

    public function is_hidden()
    {
        return $this->hidden;
    }

    public function set_hidden($hidden)
    {
        $this->hidden = $hidden;
    }

    public function has_pattern()
    {
        return $this->pattern;
    }

    public function set_pattern($pattern)
    {
        $this->pattern = $pattern;
    }

    public function has_placeholder()
    {
        return $this->placeholder;
    }

    public function set_placeholder($placeholder)
    {
        $this->placeholder = $placeholder;
    }

    public function set_template(Template $template)
    {
        $this->template = $template;
    }

    /**
     * @return Template
     */
    protected function get_template_to_use()
    {
        if ($this->template !== null)
        {
            return $this->template;
        }
        else
        {
            return $this->get_default_template();
        }
    }

    /**
     * @return Template
     */
    abstract protected function get_default_template();

    protected function get_js_specialization_code()
    {
        return '';
    }
}
?>
Annonces