Forms/src/FuzeWorks/Forms/Fields/TextField.php

<?php
/**
 * FuzeWorks Forms Library
 *
 * The FuzeWorks PHP FrameWork
 *
 * Copyright (C) 2013-${YEAR} i15
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @author    i15
 * @copyright Copyright (c) 2013 - ${YEAR}, i15. (http://i15.nl)
 * @license   https://opensource.org/licenses/MIT MIT License
 *
 * @link  https://i15.nl
 * @since Version 1.3.0
 *
 * @version Version 1.3.0
 */

namespace FuzeWorks\Forms\Fields;
use FuzeWorks\Forms\Field;
use JetBrains\PhpStorm\Pure;

class TextField extends Field
{
    // Built-in conditions
    protected int $maxLength = 0;
    protected int $minLength = 0;
    protected ?string $placeholder = null;
    protected ?string $regex = null;
    protected ?string $regexError = null;

    /**
     * Set the maximum length this text may be
     *
     * @param int $maxLength
     * @return $this
     */
    public function maxLength(int $maxLength): static
    {
        $this->maxLength = $maxLength;
        return $this;
    }

    /**
     * Set the minimum length this text must be
     *
     * @param int $minLength
     * @return $this
     */
    public function minLength(int $minLength): static
    {
        $this->minLength = $minLength;
        return $this;
    }

    /**
     * Set a placeholder inside the field for the user to see.
     *
     * @param string $placeholder
     * @return $this
     */
    public function placeholder(string $placeholder): static
    {
        $this->placeholder = $placeholder;
        return $this;
    }

    /**
     * Set a regex to match the text against.
     *
     * E.g: ^[a-z]+$  for testing if there are only lowercase letters.
     *
     * The $regexError shown be returned to the user when failing the regex.
     *
     * @param string $regex
     * @param string|null $regexError
     * @return $this
     */
    public function regex(string $regex, string $regexError = null): static
    {
        $this->regex = $regex;
        $this->regexError = $regexError;
        return $this;
    }

    protected function validateField(): bool
    {
        $valid = true;

        // Maximum length test
        if ($this->maxLength > 0 && strlen($this->value) > $this->maxLength) {
            $valid = false;
            $this->errors[] = $this->getLabel() . " exceeds maximum length of " . $this->maxLength . " characters.";
        }

        // Minimum length test
        if ($this->minLength > 0 && strlen($this->value) < $this->minLength) {
            $valid = false;
            $this->errors[] = $this->getLabel() . " must at least be " . $this->minLength . " characters.";
        }

        // Regex test
        if (!is_null($this->regex) && !preg_match('/' . $this->regex . '/mu', $this->value)) {
            $valid = false;
            if (!is_null($this->regexError))
                $this->errors[] = $this->regexError;
            else
                $this->errors[] = $this->getLabel() . " contains illegal characters.";
        }

        $this->valid = $valid;
        return $this->valid;
    }

    public function generateHtml(): string
    {
        $id = "id='".$this->getId()."'";
        $name = "name='".$this->getName()."'";
        $value = !is_null($this->value) ? "value='".$this->value."'" : "";
        $lock = $this->lock ? "disabled" : "";
        $placeholder = !is_null($this->placeholder) ? "placeholder='".$this->placeholder."'" : "";
        $maxLength = $this->maxLength > 0 ? "maxlength='".$this->maxLength."'" : "";
        $minLength = $this->minLength > 0 ? "minlength='".$this->minLength."'" : "";
        $class = "class='".implode(" ", $this->classNames)."'";

        return "<input $class type='text' $id $name $value $lock $placeholder $maxLength $minLength>";
    }
}