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;
 
    public $dataAttr;
 
    protected $class;
 
    public function __construct($name, $parameters, $form)
    {
        $this->checkName($name);
        $this->checkParameters($parameters);
 
        $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()
    {
        $this->defaults['log'] = null;
        $this->defaults['class'] = null;
        $this->defaults['dataAttr'] = [];
        $this->defaults['disabled'] = false;
    }
 
    public function __call($function, $arguments)
    {
        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;
            }
 
            return $this->htmlEscape($this->$attribute);
        } else {
            trigger_error("Call to undefined method $function", E_USER_ERROR);
        }
    }
 
    public function setDisabled($disabled = true)
    {
        $this->disabled = (bool) $disabled;
 
        return $this;
    }
 
    public function getDisabled()
    {
        return $this->disabled;
    }
 
    public function clearValue()
    {
    }
 
    public function getName()
    {
        return $this->name;
    }
 
    protected function checkParameters($parameters)
    {
        if ((isset($parameters)) && (!is_array($parameters))) {
            throw new Exceptions\ElementParametersNoArrayException('Element "' . $this->getName() . '": parameters must be of type array.');
        }
    }
 
    private function checkName($name)
    {
        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($argument, $type = null)
    {
        if (is_callable(array($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($options = array())
    {
        if (is_string($options)) {
            $htmlOptions = htmlspecialchars($options, ENT_QUOTES);
        } elseif (is_array($options)) {
            $htmlOptions = array();
 
            foreach ($options as $index => $option) {
                if (is_string($index))  $index  = htmlspecialchars($index, ENT_QUOTES);
                if (is_string($option)) $option = htmlspecialchars($option, ENT_QUOTES);
 
                $htmlOptions[$index] = $option;
            }
        } else {
            $htmlOptions = $options;
        }
 
        return $htmlOptions;
    }
 
    protected function htmlDataAttributes()
    {
        $attributes = "";
        if (is_array($this->dataAttr)) {
            foreach ($this->dataAttr as $key => $val) {
                // @todo throw error when key is not plain string?
                $attributes .= " data-$key=\"" . $this->htmlEscape($val) . "\"";
            }
        }
 
        return $attributes;
    }
}
 
/* vim:set ft=php sw=4 sts=4 fdm=marker et : */