Element.php

Go to the documentation of this file.

<?php

 
namespace Depage\HtmlForm\Abstracts;
 
use Depage\HtmlForm\Exceptions;

abstract class Element
{
    protected $name;

    public $valid;

    protected $validated = false;

    protected $log;

    protected $defaults = [];

    protected $disabled = false;

    public $dataAttr;

    protected $class;

    public function __construct(string $name, array $parameters, ?object $form)
    {
        $this->checkName($name);
 
        $this->name = $name;
 
        $this->setDefaults();
        $parameters = array_change_key_case($parameters);
        foreach ($this->defaults as $parameter => $default) {
            $this->$parameter = isset($parameters[strtolower($parameter)]) ? $parameters[strtolower($parameter)] : $default;
        }
    }

    protected function setDefaults(): void
    {
        $this->defaults['log'] = null;
        $this->defaults['class'] = null;
        $this->defaults['dataAttr'] = [];
        $this->defaults['disabled'] = false;
    }

    public function __call(string $function, array $arguments): mixed
    {
        if (substr($function, 0, 4) === 'html') {
            $attribute = str_replace('html', '', $function);
            $attribute[0] = strtolower($attribute[0]);
 
            $escapedAttribute = $attribute . "Html";
 
            if (!empty($this->$escapedAttribute)) {
                return $this->$escapedAttribute;
            }
            if (!isset($this->$attribute)) {
                throw new Exceptions\UndefinedMethodException($function);
            }
 
            return $this->htmlEscape($this->$attribute);
        } else {
            throw new Exceptions\UndefinedMethodException($function);
        }
    }

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

    public function getDisabled(): bool
    {
        return $this->disabled;
    }

    public function clearValue(): void {}

    public function getName(): string
    {
        return $this->name;
    }

    private function checkName($name): void
    {
        if (
            !is_string($name)
            || trim($name) === ''
            || preg_match('/[^a-zA-Z0-9_\-\‍[\‍]]/', $name)
        ) {
            throw new Exceptions\InvalidElementNameException('"' . $name . '" is not a valid element name.');
        }
    }

    protected function log(string $argument, ?string $type = null): void
    {
        if (is_callable([$this->log, 'log'])) {
            $this->log->log($argument, $type);
        } else {
            if (gettype($argument) != 'string') {
                ob_start();
                print_r($argument);
                $message = ob_get_contents();
                ob_end_clean();
            } else {
                $message = $argument;
            }
            error_log($message);
        }
    }

    protected function htmlEscape(array|string $options = []): array|string
    {
        if (is_string($options)) {
            $htmlOptions = htmlspecialchars($options, ENT_QUOTES | ENT_SUBSTITUTE);
        } elseif (is_array($options)) {
            $htmlOptions = [];
 
            foreach ($options as $index => $option) {
                if (is_string($index)) {
                    $index  = htmlspecialchars($index, ENT_QUOTES | ENT_SUBSTITUTE);
                }
                if (is_string($option)) {
                    $option = htmlspecialchars($option, ENT_QUOTES | ENT_SUBSTITUTE);
                }
 
                $htmlOptions[$index] = $option;
            }
        } else {
            $htmlOptions = $options;
        }
 
        return $htmlOptions;
    }

    protected function htmlList(?array $options = null, array|string|null $value = null): string
    {
        return "";
    }

    protected function htmlDataAttributes(): string
    {
        $attributes = "";
        if (is_array($this->dataAttr)) {
            foreach ($this->dataAttr as $key => $val) {
                // normalize key to lowercase
                $key = mb_strtolower($key);
 
                // Validate that key is a safe HTML5 data attribute name
                if (!is_string($key) || !preg_match('/^[a-z][a-z0-9]*(-[a-z0-9]+)*$/', $key)) {
                    continue;
                }
                // Also ensure the value is safely escaped
                $attributes .= " data-$key=\"" . $this->htmlEscape((string) $val) . "\"";
            }
        }
 
        return $attributes;
    }
}
 
/* vim:set ft=php sw=4 sts=4 fdm=marker et : */