form.php

<?php
 
class XoopsForm
{
    public $_action;

    public $_method;

    public $_name;

    public $_title;

    public $_elements = [];

    public $_extra;

    public $_required = [];


    public function __construct($title, $name, $action, $method= 'post', $addtoken = false)
    {
        $this->_title = $title;
        $this->_name = $name;
        $this->_action = $action;
        $this->_method = $method;
        if (false != $addtoken) {
            $this->addElement(new XoopsFormHiddenToken());
        }
    }
    public function XoopsForm($title, $name, $action, $method= 'post', $addtoken = false)
    {
        return self::__construct($title, $name, $action, $method, $addtoken);
    }

    public function getTitle()
    {
        return $this->_title;
    }

    public function getName()
    {
        return $this->_name;
    }

    public function getAction()
    {
        return $this->_action;
    }

    public function getMethod()
    {
        return $this->_method;
    }

    public function addElement(&$formElement, $required=false)
    {
        if (is_string($formElement)) {
            $this->_elements[] = $formElement;
        } elseif ($formElement instanceof \xoopsformelement) {
            $this->_elements[] =& $formElement;
            if ($required) {
                if (!$formElement->isContainer()) {
                    $this->_required[] =& $formElement;
                } else {
                    $required_elements =& $formElement->getRequired();
                    $count = count($required_elements);
                    for ($i = 0 ; $i < $count; $i++) {
                        $this->_required[] =& $required_elements[$i];
                    }
                }
            }
        }
    }

    public function &getElements($recurse = false)
    {
        if (!$recurse) {
            return $this->_elements;
        } else {
            $ret = [];
            $count = count($this->_elements);
            for ($i = 0; $i < $count; $i++) {
                if (!is_object($this->_elements[$i])) {
                    $ret[] = $this->_elements[$i];
                }
                if (!$this->_elements[$i]->isContainer()) {
                    $ret[] =& $this->_elements[$i];
                } else {
                    $elements =& $this->_elements[$i]->getElements(true);
                    $count2 = count($elements);
                    for ($j = 0; $j < $count2; $j++) {
                        $ret[] =& $elements[$j];
                    }
                    unset($elements);
                }
            }
            return $ret;
        }
    }

    public function getElementNames()
    {
        $ret = [];
        $elements =& $this->getElements(true);
        $count = count($elements);
        for ($i = 0; $i < $count; $i++) {
            $ret[] = $elements[$i]->getName();
        }
        return $ret;
    }

    public function &getElementByName($name)
    {
        $elements =& $this->getElements(true);
        $count = count($elements);
        for ($i = 0; $i < $count; $i++) {
            if ($name == $elements[$i]->getName()) {
                return $elements[$i];
            }
        }
        $ret = false;
        return $ret;
    }

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

    public function setElementValues($values)
    {
        if (is_array($values) && !empty($values)) {
            // will not use getElementByName() for performance..
            $elements =& $this->getElements(true);
            $count = count($elements);
            for ($i = 0; $i < $count; $i++) {
                $name = $elements[$i]->getName();
                if ($name && isset($values[$name]) && method_exists($elements[$i], 'setValue')) {
                    $elements[$i]->setValue($values[$name]);
                }
            }
        }
    }

    public function &getElementValue($name)
    {
        $ele =& $this->getElementByName($name);
        if (is_object($ele) && method_exists($ele, 'getValue')) {
            return $ele->getValue($value);
        }
 
        $ret = null;
        return $ret;
    }

    public function &getElementValues()
    {
        // will not use getElementByName() for performance..
        $elements =& $this->getElements(true);
        $count = count($elements);
        $values = [];
        for ($i = 0; $i < $count; $i++) {
            $name = $elements[$i]->getName();
            if ($name && method_exists($elements[$i], 'getValue')) {
                $values[$name] =& $elements[$i]->getValue();
            }
        }
        return $values;
    }

    public function setExtra($extra)
    {
        $this->_extra = ' ' . $extra;
    }

    public function &getExtra()
    {
        if (isset($this->_extra)) {
            $ret =& $this->_extra;
        } else {
            $ret = '';
        }
        return $ret;
    }

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

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

    public function insertBreak($extra = null)
    {
    }

    public function render()
    {
    }

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

    public function renderValidationJS($withtags = true)
    {
        $root =& XCube_Root::getSingleton();
        $renderSystem =& $root->getRenderSystem(XOOPSFORM_DEPENDENCE_RENDER_SYSTEM);
 
        $renderTarget =& $renderSystem->createRenderTarget();
 
        $renderTarget->setAttribute('legacy_module', 'legacy');
        $renderTarget->setTemplateName('legacy_xoopsform_opt_validationjs.html');
        $renderTarget->setAttribute('form', $this);
        $renderTarget->setAttribute('withtags', $withtags);
 
        $required =& $this->getRequired();
        $reqcount = count($required);
 
        $renderTarget->setAttribute('required', $required);
        $renderTarget->setAttribute('required_count', $reqcount);
 
        $renderSystem->render($renderTarget);
 
        return $renderTarget->getResult();
 
 
        $js = '';
        if ($withtags) {
            $js .= "\n<!-- Start Form Validation JavaScript //-->\n<script type='text/javascript'>\n<!--//\n";
        }
        $myts =& MyTextSanitizer::sGetInstance();
        $formname = $this->getName();
        $required =& $this->getRequired();
        $reqcount = count($required);
        $js .= "function xoopsFormValidate_{$formname}() {
    myform = window.document.$formname;\n";
        for ($i = 0; $i < $reqcount; $i++) {
            $eltname    = $required[$i]->getName();
            $eltcaption = trim($required[$i]->getCaption());
            $eltmsg = empty($eltcaption) ? sprintf(_FORM_ENTER, $eltname) : sprintf(_FORM_ENTER, $eltcaption);
            $eltmsg = str_replace('"', '\"', stripslashes($eltmsg));
            $js .= "if ( myform.{$eltname}.value == \"\" ) "
                . "{ window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }\n";
        }
        $js .= "return true;\n}\n";
        if ($withtags) {
            $js .= "//--></script>\n<!-- End Form Validation JavaScript //-->\n";
        }
        return $js;
    }

    public function assign(&$tpl)
    {
        $i = 0;
        $elements = [];
        foreach ($this->getElements() as $ele) {
            $n = ('' != $ele->getName()) ? $ele->getName() : $i;
            $elements[$n]['name']     = $ele->getName();
            $elements[$n]['caption']  = $ele->getCaption();
            $elements[$n]['body']     = $ele->render();
            $elements[$n]['hidden']   = $ele->isHidden();
            if ('' != $ele->getDescription()) {
                $elements[$n]['description']  = $ele->getDescription();
            }
            $i++;
        }
        $js = $this->renderValidationJS();
        $tpl->assign($this->getName(), ['title' => $this->getTitle(), 'name' => $this->getName(), 'action' => $this->getAction(), 'method' => $this->getMethod(), 'extra' => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '();"' . $this->getExtra(), 'javascript' => $js, 'elements' => $elements]
        );
    }
}