Element.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/


namespace Xoops\Form;

use Xoops\Html\Attributes;

abstract class Element extends Attributes
{

    public $customValidationCode = array();

    //private $name = '';

    private $caption = '';

    //private $accesskey = '';

    //private $class = array();

    //private $pattern;

    private $pattern_description;

    private $datalist;

    //private $hidden = false;

    private $extra = array();

    //private $required = false;

    private $description = '';

    protected $value = '';

    private $maxcols = 6;

    abstract public function render();


    public function renderAttributeString()
    {
        // title attribute needs to be generated if not already set
        if (!$this->hasAttribute('title')) {
            $this->setAttribute('title', $this->getTitle());
        }
        // generate id from name if not already set
        if (!$this->hasAttribute('id')) {
            $id = $this->getAttribute('name');
            if (substr($id, -2) == '[]') {
                $id = substr($id, 0, strlen($id)-2);
            }
            $this->setAttribute('id', $id);
        }
        return parent::renderAttributeString();
    }

    public function getValue($encode = false)
    {
        if (is_array($this->value)) {
            $ret = array();
            foreach ($this->value as $value) {
                $ret[] = $encode ? htmlspecialchars($value, ENT_QUOTES) : $value;
            }
            return $ret;
        }
        return $encode ? htmlspecialchars($this->value, ENT_QUOTES) : $this->value;
    }

    public function setValue($value)
    {
        if (is_array($value)) {
            $this->value = (array)$this->value;
            foreach ($value as $v) {
                $this->value[] = $v;
            }
        } elseif (is_array($this->value)) {
            $this->value[] = $value;
        } else {
            $this->value = $value;
        }
    }

    public function setName($name)
    {
        $this->setAttribute('name', $name);
    }

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

    public function setAccessKey($key)
    {
        $this->setAttribute('accesskey', $key);
    }

    public function getAccessKey()
    {
        return (string) $this->getAttribute('accesskey');
    }

    public function getAccessString($str)
    {
        $access = $this->getAccessKey();
        if (!empty($access) && (false !== ($pos = strpos($str, $access)))) {
            return htmlspecialchars(substr($str, 0, $pos), ENT_QUOTES)
                . '<span style="text-decoration: underline;">'
                . htmlspecialchars(substr($str, $pos, 1), ENT_QUOTES) . '</span>'
                . htmlspecialchars(substr($str, $pos + 1), ENT_QUOTES);
        }
        return htmlspecialchars($str, ENT_QUOTES);
    }

    public function setClass($class)
    {
        $this->addAttribute('class', (string) $class);
    }

    public function getClass()
    {
        $class = $this->getAttribute('class');
        if ($class === false) {
            return false;
        }
        return htmlspecialchars(implode(' ', $class), ENT_QUOTES);
    }

    public function setPattern($pattern, $pattern_description = '')
    {
         $this->setAttribute('pattern', $pattern);
         $this->pattern_description = trim($pattern_description);
    }

    public function getPattern()
    {
        return (string) $this->getAttribute('pattern');
    }

    public function getPatternDescription()
    {
        if (empty($this->pattern_description)) {
            return '';
        }
        return $this->pattern_description;
    }

    public function setDatalist($datalist)
    {
        if (is_array($datalist)) {
            if (!empty($datalist)) {
                $this->datalist = $datalist;
            }
        } else {
            $this->datalist[] = trim($datalist);
        }
    }

    public function getDatalist()
    {
        if (empty($this->datalist)) {
            return '';
        }
        $ret = NWLINE . '<datalist id="list_' . $this->getName() . '">' . NWLINE;
        foreach ($this->datalist as $datalist) {
            $ret .= '<option value="' . htmlspecialchars($datalist, ENT_QUOTES) . '">' . NWLINE;
        }
        $ret .= '</datalist>' . NWLINE;
        return $ret;
    }

    public function isDatalist()
    {
        if (empty($this->datalist)) {
            return false;
        }
        return true;
    }

    public function setCaption($caption)
    {
        $this->caption = trim($caption);
    }

    public function getCaption()
    {
        return $this->caption;
        //return htmlspecialchars($this->caption, ENT_QUOTES);
    }

    public function setTitle($title)
    {
        $this->setAttribute('title', $title);
    }

    public function getTitle()
    {
        if ($this->hasAttribute('title')) {
            return $this->getAttribute('title');
        } else {
            if (strlen($this->pattern_description) > 0) {
                return htmlspecialchars(strip_tags($this->caption . ' - ' . $this->pattern_description), ENT_QUOTES);
            } else {
                return htmlspecialchars(strip_tags($this->caption), ENT_QUOTES);
            }
        }
    }

    public function setDescription($description)
    {
        $this->description = trim($description);
    }

    public function getDescription($encode = false)
    {
        return $encode ? htmlspecialchars($this->description, ENT_QUOTES) : $this->description;
    }

    public function setHidden()
    {
        $this->setAttribute('hidden');
    }

    public function isHidden()
    {
        return $this->hasAttribute('hidden');
    }

    public function setRequired($bool = true)
    {
        if ($bool) {
            $this->setAttribute('required');
        }
    }

    public function isRequired()
    {
        return $this->hasAttribute('required');
    }

    public function setExtra($extra, $replace = false)
    {
        if ($replace) {
            $this->extra = array(trim($extra));
        } else {
            $this->extra[] = trim($extra);
        }
        return $this->extra;
    }

    public function getExtra($encode = false)
    {
        if (!$encode) {
            return implode(' ', $this->extra);
        }
        $value = array();
        foreach ($this->extra as $val) {
            $value[] = str_replace('>', '&gt;', str_replace('<', '&lt;', $val));
        }
        return empty($value) ? '' : ' ' . implode(' ', $value);
    }

    public function renderValidationJS()
    {
        // render custom validation code if any
        if (!empty($this->customValidationCode)) {
            return implode(NWLINE, $this->customValidationCode);
            // generate validation code if required
        } else {
            if ($this->isRequired() && $eltname = $this->getName()) {
                // $eltname    = $this->getName();
                $eltcaption = $this->getCaption();
                $eltmsg = empty($eltcaption)
                    ? sprintf(\XoopsLocale::F_ENTER, $eltname)
                    : sprintf(\XoopsLocale::F_ENTER, $eltcaption);
                $eltmsg = str_replace(array(':', '?', '%'), '', $eltmsg);
                $eltmsg = str_replace('"', '\"', stripslashes($eltmsg));
                $eltmsg = strip_tags($eltmsg);
                return NWLINE
                    . "if ( myform.{$eltname}.value == \"\" ) { window.alert(\"{$eltmsg}\");"
                    . " myform.{$eltname}.focus(); return false; }\n";
            }
        }
        return false;
    }

    public function getMaxcols()
    {
        return $this->maxcols;
    }
}