Input.php

Go to the documentation of this file.

<?php

 
namespace Depage\HtmlForm\Abstracts;
 
use Depage\HtmlForm\Validators;

abstract class Input extends Element
{
    protected $type;

    protected $label;

    protected $labelHtml;

    protected $title;

    protected $lang;

    protected $defaultValue;

    protected $marker;

    protected $required;

    protected $readonly;

    protected $formName;

    protected $value = null;

    protected $validator;

    protected $class;

    protected $classes;

    protected $autofocus = false;

    protected $autocapitalize;

 
    protected $autocorrect;
    protected $autocomplete;

    protected $pattern;

    protected $errorMessage;

    protected $helpMessage;

    protected $helpMessageHtml;

    public $dataPath;

    public function __construct(string $name, array $parameters, object $form)
    {
        $this->type         = str_replace('Depage\\HtmlForm\\Elements\\', '', get_class($this));
        $this->formName     = $form->getName();
 
        parent::__construct($name, $parameters, $form);
 
        $this->validator    = (isset($parameters['validator']))
            ? Validators\Validator::factory($parameters['validator'], $this->log)
            : Validators\Validator::factory($this->type, $this->log);
    }

    protected function setDefaults(): void
    {
        parent::setDefaults();
 
        $this->defaults['autocapitalize']  = null;
        $this->defaults['autocomplete']    = null;
        $this->defaults['autocorrect']     = null;
        $this->defaults['autofocus']       = false;
        $this->defaults['errorMessage']    = _('Please enter valid data');
        $this->defaults['label']           = $this->name;
        $this->defaults['labelHtml']       = '';
        $this->defaults['marker']          = '*';
        $this->defaults['required']        = false;
        $this->defaults['readonly']        = false;
        $this->defaults['title']           = false;
        $this->defaults['class']           = '';
        $this->defaults['lang']            = '';
        $this->defaults['helpMessage']     = '';
        $this->defaults['helpMessageHtml'] = '';
        $this->defaults['dataPath']        = null;
    }

    public function validate(): bool
    {
        if (!$this->validated) {
            $this->validated = true;
 
            $this->valid = (
                ($this->value !== null)
                && ($this->validatorCall() || $this->isEmpty())
                && (!$this->isEmpty() || !$this->required)
            );
        }
 
        return $this->valid;
    }

    public function invalidate(): self
    {
        $this->validated = true;
        $this->valid = false;
 
        return $this;
    }

    protected function validatorCall(): bool
    {
        return $this->validator->validate($this->value);
    }

    public function isEmpty(): bool
    {
        return (
            empty($this->value)
            && $this->value !== '0'
            && $this->value !== false
        );
    }

    public function setValue(mixed $newValue): mixed
    {
        $this->value = $newValue;
        $this->typeCastValue();
        $this->validated = false;
 
        return $this->value;
    }

    public function getValue(): mixed
    {
        return $this->value;
    }

    public function setLabel(string $label): self
    {
        $this->label = $label;
 
        return $this;
    }

    public function getLabel(): string
    {
        return $this->label;
    }

    public function setErrorMessage(string $message): self
    {
        $this->errorMessage = $message;
 
        return $this;
    }

    public function getErrorMessage(): string
    {
        return $this->errorMessage;
    }

    public function clearValue(): void
    {
        $this->value = null;
    }

    public function setDefaultValue(mixed $newDefaultValue): self
    {
        $this->defaultValue = $newDefaultValue;
 
        return $this;
    }

    public function getDefaultValue(): mixed
    {
        return $this->defaultValue;
    }

    protected function typeCastValue(): void
    {
        // to be overridden by child classes
    }

    public function setAutofocus(bool $autofocus = true): self
    {
        $this->autofocus = (bool) $autofocus;
 
        return $this;
    }

    public function setRequired(bool $required = true): self
    {
        $this->required = (bool) $required;
        $this->validated = false;
 
        return $this;
    }

    protected function htmlClasses()
    {
        $classes = 'input-' . $this->htmlEscape(strtolower($this->type));
 
        if ($this->required) {
            $classes .= ' required';
        }
        if ($this->disabled) {
            $classes .= ' disabled';
        }
        if ($this->readonly) {
            $classes .= ' readonly';
        }
        if (($this->value !== null) && (!$this->validate())) {
            $classes .= ' error';
        }
        if (isset($this->skin)) {
            $classes .= ' skin-' . $this->htmlEscape($this->skin);
        }
        if (!empty($this->class)) {
            $classes .= ' ' . $this->htmlEscape($this->class);
        }
 
        return $classes;
    }

    protected function htmlMarker()
    {
        return ($this->required) ? " <em>" . $this->htmlEscape($this->marker) . "</em>" : "";
    }

    protected function htmlInputAttributes(): string
    {
        $attributes = '';
 
        if ($this->required) {
            $attributes .= ' required="required"';
        }
        if ($this->disabled) {
            $attributes .= ' disabled="disabled"';
        }
        if ($this->readonly) {
            $attributes .= ' readonly="readonly"';
        }
        if ($this->autofocus) {
            $attributes .= ' autofocus="autofocus"';
        }
 
        $autoAttributes = [
            "autocapitalize",
            "autocorrect",
        ];
        foreach ($autoAttributes as $attr) {
            if (!is_null($this->$attr)) {
                if ($this->$attr) {
                    $attributes .= " $attr=\"on\"";
                } else {
                    $attributes .= " $attr=\"off\"";
                }
            }
        }
        // enable autocomplete attribute according to
        // https://html.spec.whatwg.org/multipage/forms.html#autofill
        if (!is_null($this->autocomplete)) {
            if (is_string($this->autocomplete)) {
                $attributes .= " autocomplete=\"" . $this->htmlEscape($this->autocomplete) . "\"";
            } elseif ($this->autocomplete === true) {
                $attributes .= " autocomplete=\"on\"";
            } else {
                $attributes .= " autocomplete=\"off\"";
            }
        }
 
        return $attributes;
    }

    protected function htmlDataAttributes(): string
    {
        $this->dataAttr['errorMessage'] = $this->errorMessage;
 
        return parent::htmlDataAttributes();
    }

    protected function htmlWrapperAttributes()
    {
        $attributes = "id=\"{$this->formName}-{$this->name}\" ";
 
        $attributes .= "class=\"" . $this->htmlClasses() . "\"";
 
        $attributes .= ($this->title) ? " title=\"" . $this->htmlEscape($this->title) . "\"" : "";
 
        $attributes .= ($this->lang) ? " lang=\"" . $this->htmlEscape($this->lang) . "\"" : "";
 
        $attributes .= $this->htmlDataAttributes();
 
        return $attributes;
    }

    protected function htmlValue()
    {
        return $this->htmlEscape($this->value === null ? $this->defaultValue : $this->value);
    }

    protected function htmlErrorMessage()
    {
        if (!$this->valid
            && $this->value !== null
            && $this->errorMessage !== ""
        ) {
            $errorMessage = "<span class=\"errorMessage\">" . $this->htmlEscape($this->errorMessage) . "</span>";
        } else {
            $errorMessage = "";
        }
 
        return $errorMessage;
    }

    protected function htmlHelpMessage()
    {
        $helpMessage = '';
        if (isset($this->helpMessage) && !empty($this->helpMessage)) {
            // escaped message
            $helpMessage = "<span class=\"helpMessage\">" . $this->htmlEscape($this->helpMessage) . "</span>";
        }
        if (isset($this->helpMessageHtml) && !empty($this->helpMessageHtml)) {
            // html message
            $helpMessage = "<span class=\"helpMessage\">" . $this->helpMessageHtml . "</span>";
        }
 
        return $helpMessage;
    }
}
 
/* vim:set ft=php sw=4 sts=4 fdm=marker et : */