Form.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;

abstract class Form implements ContainerInterface
{
    private $action;

    private $method;

    private $name;

    private $title;

    private $display = '';

    private $elements = array();

    private $extra = array();

    private $required = array();

    private $summary = '';

    public function __construct($title, $name, $action, $method = 'post', $addtoken = false, $display = '')
    {
        $this->title = $title;
        $this->name = $name;
        $this->action = $action;
        $this->method = $method;
        $this->display = $display;
        if ($addtoken != false) {
            $this->addElement(new Token());
        }
    }

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

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

    public function setTitle($title)
    {
        $this->title = $title;
    }

    public function getName($encode = true)
    {
        return $encode ? htmlspecialchars($this->name, ENT_QUOTES) : $this->name;
    }

    public function setAction($value = '')
    {
        $this->action = $value;
    }

    public function getAction($encode = true)
    {
        // Convert &amp; to & for backward compatibility
        return $encode ? htmlspecialchars(str_replace('&amp;', '&', $this->action), ENT_QUOTES) : $this->action;
    }

    public function getMethod()
    {
        return (strtolower($this->method) == 'get') ? 'get' : 'post';
    }

    public function addElement(Element $formElement, $required = false)
    {
        /* @var Element $formElement */
        $this->elements[] = $formElement;
        if ($formElement instanceof ContainerInterface) {
            /* @var $formElement ContainerInterface */
            $required_elements = $formElement->getRequired();
            $count = count($required_elements);
            for ($i = 0; $i < $count; ++$i) {
                $this->required[] = $required_elements[$i];
            }
        } else {
            if ($required && !$formElement instanceof Raw) {
                $formElement->setRequired();
                $this->required[] = $formElement;
            }
        }
    }

    public function getElements($recurse = false)
    {
        if (!$recurse) {
            return $this->elements;
        } else {
            $ret = array();
            foreach ($this->elements as $ele) {
                if ($ele instanceof ContainerInterface) {
                    /* @var $ele ContainerInterface */
                    $elements = $ele->getElements(true);
                    foreach ($elements as $ele2) {
                        $ret[] = $ele2;
                    }
                    unset($elements);
                    unset($ele2);
                } else {
                    $ret[] = $ele;
                }
                unset($ele);
            }
            return $ret;
        }
    }

    public function getElementNames()
    {
        $ret = array();
        $elements = $this->getElements(true);
        foreach ($elements as $ele) {
            /* @var Element $ele */
            $ret[] = $ele->getName();
            unset($ele);
        }
        return $ret;
    }

    public function getElementByName($name)
    {
        $elements = $this->getElements(true);
        foreach ($elements as $ele) {
            /* @var Element $ele */
            if ($name == $ele->getName()) {
                return $ele;
            }
        }
        $ele = null;
        return $ele;
    }

    public function setElementValue($name, $value)
    {
        $ele = $this->getElementByName($name);
        if (is_object($ele)) {
            $ele->setValue($value);
        }
    }

    public function setElementValues($values)
    {
        if (is_array($values) && !empty($values)) {
            // will not use getElementByName() for performance..
            $elements = $this->getElements(true);
            foreach ($elements as $ele) {
                /* @var $ele Element */
                $name = $ele->getName();
                if ($name && isset($values[$name])) {
                    $ele->setValue($values[$name]);
                }
            }
        }
    }

    public function getElementValue($name, $encode = false)
    {
        $ele = $this->getElementByName($name);
        return $ele->getValue($encode);
    }

    public function getElementValues($encode = false)
    {
        // will not use getElementByName() for performance..
        $elements = $this->getElements(true);
        $values = array();
        foreach ($elements as $ele) {
            /* @var Element $ele */
            $name = $ele->getName();
            if ($name) {
                $values[$name] = $ele->getValue($encode);
            }
        }
        return $values;
    }

    public function setExtra($extra)
    {
        if (!empty($extra)) {
            $this->extra[] = $extra;
        }
    }

    public function setSummary($summary)
    {
        if (!empty($summary)) {
            $this->summary = strip_tags($summary);
        }
    }

    public function getExtra()
    {
        $extra = empty($this->extra) ? '' : ' ' . implode(' ', $this->extra);
        return $extra;
    }

    public function setRequired(Element $formElement)
    {
        $this->required[] = $formElement;
    }

    public function getRequired()
    {
        return $this->required;
    }

    abstract public function render();

    public function display()
    {
        echo $this->render();
    }

    public function renderValidationJS($withtags = true)
    {
        $js = '';
        if ($withtags) {
            $js .= "\n<!-- Start Form Validation JavaScript //-->\n<script type='text/javascript'>\n<!--//\n";
        }
        $formname = $this->getName();
        $js .= "function xoopsFormValidate_{$formname}() { var myform = window.document.{$formname}; ";
        $elements = $this->getElements(true);
        foreach ($elements as $ele) {
            /* @var Element $ele */
            $js .= $ele->renderValidationJS();
        }
        $js .= "return true;\n}\n";
        if ($withtags) {
            $js .= "//--></script>\n";
            $js .= "<!-- End Form Validation JavaScript //-->\n";
        }
        return $js;
    }

    public function assign(\XoopsTpl $tpl)
    {
        $i = -1;
        $elements = array();
        if (count($this->getRequired()) > 0) {
            $this->elements[] =
                new Raw("<tr class='foot'><td colspan='2'>* = " . \XoopsLocale::REQUIRED . "</td></tr>");
        }
        foreach ($this->getElements() as $ele) {
            ++$i;
            /* @var Element $ele */
            $ele_name = $ele->getName();
            $ele_description = $ele->getDescription();
            $n = $ele_name ? $ele_name : $i;
            $elements[$n]['name'] = $ele_name;
            $elements[$n]['caption'] = $ele->getCaption();
            $elements[$n]['body'] = $ele->render();
            $elements[$n]['hidden'] = $ele->isHidden();
            $elements[$n]['required'] = $ele->isRequired();
            if ($ele_description != '') {
                $elements[$n]['description'] = $ele_description;
            }
        }
        $js = $this->renderValidationJS();
        $tpl->assign($this->getName(), array(
                'title' => $this->getTitle(), 'name' => $this->getName(), 'action' => $this->getAction(),
                'method' => $this->getMethod(),
                'extra' => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '();"' . $this->getExtra(),
                'javascript' => $js, 'elements' => $elements
            ));
    }
}