mambax7 / smartobject

class/Form/SmartObjectForm.php

<?php namespace XoopsModules\Smartobject\Form;

/**
 * Contains the class responsible for providing forms related to a SmartObject
 *
 * @license    GNU
 * @author     marcan <marcan@smartfactory.ca>
 * @link       http://smartfactory.ca The SmartFactory
 * @package    SmartObject
 * @subpackage SmartObjectForm
 */

use XoopsModules\Smartobject;
/** @var Smartobject\Helper $helper */
$helper = Smartobject\Helper::getInstance();

// defined('XOOPS_ROOT_PATH') || die('Restricted access');

/**
 * Including the XoopsFormLoader classes
 */
use XoopsFormDhtmlTextArea;
use XoopsFormEditor;
use XoopsFormElement;
use XoopsFormTextArea;
use XoopsModules\Smartobject\Form\Elements\SmartFormCheckElement;
use XoopsModules\Smartobject\Form\Elements\SmartFormRichFileElement;
use XoopsModules\Smartobject\Form\Elements\SmartFormSection;
use XoopsModules\Smartobject\Form\Elements\SmartFormSectionClose;
use XoopsModules\Smartobject\Form\Elements\SmartFormUrlLinkElement;

require_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';
//require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsection.php';
//require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsectionclose.php';

/**
 * SmartForm base class
 *
 * Base class representing a single form for a specific SmartObject
 *
 * @package SmartObject
 * @author  marcan <marcan@smartfactory.ca>
 * @link    http://smartfactory.ca The SmartFactory
 */
class SmartObjectForm extends \XoopsThemeForm
{
    public $targetObject           = null;
    public $form_fields            = null;
    public $_cancel_js_action      = false;
    public $_custom_button         = false;
    public $_captcha               = false;
    public $_form_name             = false;
    public $_form_caption          = false;
    public $_submit_button_caption = false;

    /**
     * SmartobjectForm constructor.
     * @param string $target
     * @param string $form_name
     * @param string $form_caption
     * @param string $form_action
     * @param null   $form_fields
     * @param bool   $submit_button_caption
     * @param bool   $cancel_js_action
     * @param bool   $captcha
     */
    public function __construct(
        &$target,
        $form_name,
        $form_caption,
        $form_action,
        $form_fields = null,
        $submit_button_caption = false,
        $cancel_js_action = false,
        $captcha = false
    ) {
        $this->targetObject           =& $target;
        $this->form_fields            = $form_fields;
        $this->_cancel_js_action      = $cancel_js_action;
        $this->_captcha               = $captcha;
        $this->_form_name             = $form_name;

The property $_form_name was declared of type boolean, but $form_name is of type string. Maybe add a type cast?

        $this->_form_caption          = $form_caption;

The property $_form_caption was declared of type boolean, but $form_caption is of type string. Maybe add a type cast?

        $this->_submit_button_caption = $submit_button_caption;

        if (!isset($form_action)) {
            $form_action = xoops_getenv('PHP_SELF');
        }

        parent::__construct($form_caption, $form_name, $form_action, 'post', true);
        $this->setExtra('enctype="multipart/form-data"');

        $this->createElements();

        if ($captcha) {
            $this->addCaptcha();
        }

        $this->createPermissionControls();

        $this->createButtons($form_name, $form_caption, $submit_button_caption);
    }

    public function addCaptcha()
    {
        require_once SMARTOBJECT_ROOT_PATH . 'include/captcha/formcaptcha.php';
        $this->addElement(new \XoopsFormCaptcha(), true);
    }

    /**
     * @param      $name
     * @param      $caption
     * @param bool $onclick
     */
    public function addCustomButton($name, $caption, $onclick = false)
    {
        $custom_button_array    = [
            'name'    => $name,
            'caption' => $caption,
            'onclick' => $onclick
        ];
        $this->_custom_button[] = $custom_button_array;
    }

    /**
     * Add an element to the form
     *
     * @param string|XoopsFormElement &$formElement reference to a {@link XoopsFormElement}
     * @param bool                    $key
     * @param bool                    $var
     * @param bool|string             $required     is this a "required" element?
     */
    public function addElement($formElement, $key = false, $var = false, $required = 'notset')
    {
        if ($key) {
            if ($this->targetObject->vars[$key]['readonly']) {
                $formElement->setExtra('disabled="disabled"');
                $formElement->setName($key . '-readonly');
                // Since this element is disable, we still want to pass it's value in the form
                $hidden = new \XoopsFormHidden($key, $this->targetObject->vars[$key]['value']);
                $this->addElement($hidden);
            }
            $formElement->setDescription($var['form_dsc']);
            if (isset($this->targetObject->controls[$key]['onSelect'])) {
                $hidden = new \XoopsFormHidden('changedField', false);
                $this->addElement($hidden);
                $otherExtra      = isset($var['form_extra']) ? $var['form_extra'] : '';
                $onchangedString = "this.form.elements.changedField.value='$key'; this.form.elements.op.value='changedField'; submit()";
                $formElement->setExtra('onchange="' . $onchangedString . '"' . ' ' . $otherExtra);
            } else {
                if (isset($var['form_extra'])) {
                    $formElement->setExtra($var['form_extra']);
                }
            }
            $controls = $this->targetObject->controls;
            if (isset($controls[$key]['js'])) {
                $formElement->customValidationCode[] = $controls[$key]['js'];
            }
            parent::addElement($formElement, 'notset' === $required ? $var['required'] : $required);
        } else {
            parent::addElement($formElement, 'notset' === $required ? false : true);
        }
        unset($formElement);
    }

    public function createElements()
    {
        $controls = $this->targetObject->controls;
        $vars     = $this->targetObject->vars;
        foreach ($vars as $key => $var) {

            // If $displayOnForm is false OR this is the primary key, it doesn't
            // need to be displayed, then we only create an hidden field
            if ($key == $this->targetObject->handler->keyName || !$var['displayOnForm']) {
                $elementToAdd = new \XoopsFormHidden($key, $var['value']);
                $this->addElement($elementToAdd, $key, $var, false);
                unset($elementToAdd);
            // If not, the we need to create the proper form control for this fields
            } else {
                // If this field has a specific control, we will use it

                if ('parentid' === $key) {
                    /**
                     * Why this ?
                     */
                }
                if (isset($controls[$key])) {
                    /* If the control has name, it's because it's an object already present in the script
                     * for example, "user"
                     * If the field does not have a name, than we will use a "select" (ie XoopsFormSelect)
                     */
                    if (!isset($controls[$key]['name']) || !$controls[$key]['name']) {
                        $controls[$key]['name'] = 'select';
                    }

                    $form_select = $this->getControl($controls[$key]['name'], $key);

                    // Adding on the form, the control for this field
                    $this->addElement($form_select, $key, $var);
                    unset($form_select);

                // If this field don't have a specific control, we will use the standard one, depending on its data type
                } else {
                    switch ($var['data_type']) {

                        case XOBJ_DTYPE_TXTBOX:

                            $form_text = $this->getControl('text', $key);
                            $this->addElement($form_text, $key, $var);
                            unset($form_text);
                            break;

                        case XOBJ_DTYPE_INT:

This code seems to be duplicated across your project.

                            $this->targetObject->setControl($key, [

The method setControl cannot be called on $this->targetObject (of type string).

                                'name' => 'text',
                                'size' => '5'
                            ]);
                            $form_text = $this->getControl('text', $key);
                            $this->addElement($form_text, $key, $var);
                            unset($form_text);
                            break;

                        case XOBJ_DTYPE_FLOAT:

This code seems to be duplicated across your project.

                            $this->targetObject->setControl($key, [

The method setControl cannot be called on $this->targetObject (of type string).

                                'name' => 'text',
                                'size' => '5'
                            ]);
                            $form_text = $this->getControl('text', $key);
                            $this->addElement($form_text, $key, $var);
                            unset($form_text);
                            break;

                        case XOBJ_DTYPE_LTIME:
                            $form_date_time = $this->getControl('date_time', $key);
                            $this->addElement($form_date_time, $key, $var);
                            unset($form_date_time);
                            break;

                        case XOBJ_DTYPE_STIME:
                            $form_date_time = $this->getControl('date', $key);
                            $this->addElement($form_date_time, $key, $var);
                            unset($form_date_time);
                            break;

                        case XOBJ_DTYPE_TIME_ONLY:
                            $form_time = $this->getControl('time', $key);
                            $this->addElement($form_time, $key, $var);
                            unset($form_time);
                            break;

                        case XOBJ_DTYPE_CURRENCY:

This code seems to be duplicated across your project.

                            $this->targetObject->setControl($key, [

The method setControl cannot be called on $this->targetObject (of type string).

                                'name' => 'text',
                                'size' => '15'
                            ]);
                            $form_currency = $this->getControl('text', $key);
                            $this->addElement($form_currency, $key, $var);
                            unset($form_currency);
                            break;

                        case XOBJ_DTYPE_URLLINK:
                            $form_urllink = $this->getControl('urllink', $key);
                            $this->addElement($form_urllink, $key, $var);
                            unset($form_urllink);
                            break;

                        case XOBJ_DTYPE_FILE:
                            $form_file = $this->getControl('richfile', $key);
                            $this->addElement($form_file, $key, $var);
                            unset($form_file);
                            break;

                        case XOBJ_DTYPE_TXTAREA:

                            $form_text_area = $this->getTextArea($key, $var);
                            $this->addElement($form_text_area, $key, $var);
                            unset($form_text_area);
                            break;

                        case XOBJ_DTYPE_ARRAY:
                            // TODO: To come...
                            break;
                        case XOBJ_DTYPE_SOURCE:
                            // TODO: To come...
                            break;
                        case XOBJ_DTYPE_FORM_SECTION:
                            $section_control = new SmartFormSection($key, $var['value']);
                            $this->addElement($section_control, $key, $var);
                            unset($section_control);
                            break;
                        case XOBJ_DTYPE_FORM_SECTION_CLOSE:
                            $section_control = new SmartFormSectionClose($key, $var['value']);
                            $this->addElement($section_control, $key, $var);
                            unset($section_control);
                            break;
                    }
                }
            }
        }
        // Add an hidden field to store the URL of the page before this form
        $this->addElement(new \XoopsFormHidden('smart_page_before_form', Smartobject\Utility::getPageBeforeForm()));
    }

    public function createPermissionControls()
    {
        $smartModuleConfig = $this->targetObject->handler->getModuleConfig();

        $permissions = $this->targetObject->handler->getPermissions();

        if ($permissions) {
            $memberHandler = xoops_getHandler('member');
            $group_list    = $memberHandler->getGroupList();
            asort($group_list);
            foreach ($permissions as $permission) {
                if ($this->targetObject->isNew()) {

The method isNew cannot be called on $this->targetObject (of type string).

                    if (isset($smartModuleConfig['def_perm_' . $permission['perm_name']])) {
                        $groups_value = $smartModuleConfig['def_perm_' . $permission['perm_name']];
                    }
                } else {
                    $groups_value = $this->targetObject->getGroupPerm($permission['perm_name']);

The method getGroupPerm cannot be called on $this->targetObject (of type string).

                }
                $groups_select = new \XoopsFormSelect($permission['caption'], $permission['perm_name'], $groups_value, 4, true);

The variable $groups_value does not seem to be defined for all execution paths leading up to this point.

                $groups_select->setDescription($permission['description']);
                $groups_select->addOptionArray($group_list);
                $this->addElement($groups_select);
                unset($groups_select);
            }
        }
    }

    /**
     * @param      $form_name
     * @param      $form_caption
     * @param bool $submit_button_caption
     */
    public function createButtons($form_name, $form_caption, $submit_button_caption = false)
    {
        $button_tray = new \XoopsFormElementTray('', '');
        $button_tray->addElement(new \XoopsFormHidden('op', $form_name));
        if (!$submit_button_caption) {
            if ($this->targetObject->isNew()) {

The method isNew cannot be called on $this->targetObject (of type string).

                $butt_create = new \XoopsFormButton('', 'create_button', _CO_SOBJECT_CREATE, 'submit');
            } else {
                $butt_create = new \XoopsFormButton('', 'modify_button', _CO_SOBJECT_MODIFY, 'submit');
            }
        } else {
            $butt_create = new \XoopsFormButton('', 'modify_button', $submit_button_caption, 'submit');
        }
        $butt_create->setExtra('onclick="this.form.elements.op.value=\'' . $form_name . '\'"');
        $button_tray->addElement($butt_create);

        //creating custom buttons
        if ($this->_custom_button) {
            foreach ($this->_custom_button as $custom_button) {

The expression $this->_custom_button of type boolean is not traversable.

                $butt_custom = new \XoopsFormButton('', $custom_button['name'], $custom_button['caption'], 'submit');
                if ($custom_button['onclick']) {
                    $butt_custom->setExtra('onclick="' . $custom_button['onclick'] . '"');
                }
                $button_tray->addElement($butt_custom);
                unset($butt_custom);
            }
        }

        // creating the "cancel" button
        $butt_cancel = new \XoopsFormButton('', 'cancel_button', _CO_SOBJECT_CANCEL, 'button');
        if ($this->_cancel_js_action) {
            $butt_cancel->setExtra('onclick="' . $this->_cancel_js_action . '"');
        } else {
            $butt_cancel->setExtra('onclick="history.go(-1)"');
        }
        $button_tray->addElement($butt_cancel);

        $this->addElement($button_tray);
    }

    /**
     * @param $controlName
     * @param $key
     * @return \XoopsFormLabel
     */
    public function getControl($controlName, $key)
    {
        switch ($controlName) {
            case 'check':

This code seems to be duplicated across your project.

//                require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformcheckelement.php';
                $control    = $this->targetObject->getControl($key);

The method getControl cannot be called on $this->targetObject (of type string).

                $controlObj = new SmartFormCheckElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));

The method getVar cannot be called on $this->targetObject (of type string).

                $controlObj->addOptionArray($control['options']);

                return $controlObj;
                break;

break is not strictly necessary here and could be removed.

            case 'color':
                $control    = $this->targetObject->getControl($key);

The method getControl cannot be called on $this->targetObject (of type string).

$control is not used, you could remove the assignment.

                $controlObj = new \XoopsFormColorPicker($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));

The method getVar cannot be called on $this->targetObject (of type string).

                return $controlObj;

The return type of return $controlObj; (XoopsFormColorPicker) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'radio':

This code seems to be duplicated across your project.

                $control = $this->targetObject->getControl($key);

The method getControl cannot be called on $this->targetObject (of type string).

                $controlObj = new \XoopsFormRadio($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));

The method getVar cannot be called on $this->targetObject (of type string).

                $controlObj->addOptionArray($control['options']);

                return $controlObj;

The return type of return $controlObj; (XoopsFormRadio) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'label':
                return new \XoopsFormLabel($this->targetObject->vars[$key]['form_caption'], $this->targetObject->getVar($key));

The method getVar cannot be called on $this->targetObject (of type string).

                break;

break is not strictly necessary here and could be removed.

            case 'textarea':
                return $this->getTextArea($key);

The return type of return $this->getTextArea($key); (XoopsFormTinymce|XoopsFormDhtmlTextArea|XoopsFormTextArea|XoopsFormEditor) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

            case 'theme':
                return $this->getThemeSelect($key, $this->targetObject->vars[$key]);

The return type of return $this->getThemeSelect($key, $this->targetObject->vars[$key]); (XoopsFormSelect) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

            case 'theme_multi':
                return $this->getThemeSelect($key, $this->targetObject->vars[$key], true);

The return type of return $this->getThemeSelect($key, $this->targetObject->vars[$key], true); (XoopsFormSelect) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'timezone':
                return new \XoopsFormSelectTimezone($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key));

The method getVar cannot be called on $this->targetObject (of type string).

The return type of return new \XoopsFormSelectTimezone($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key)); (XoopsFormSelectTimezone) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'group':

This code seems to be duplicated across your project.

                return new \XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 1, false);

The method getVar cannot be called on $this->targetObject (of type string).

The return type of return new \XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 1, false); (XoopsFormSelectGroup) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'group_multi':

This code seems to be duplicated across your project.

                return new \XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);

The method getVar cannot be called on $this->targetObject (of type string).

The return type of return new \XoopsFormSelectGroup($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true); (XoopsFormSelectGroup) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            /*case 'user':
             return new \XoopsFormSelectUser($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 1, false);
             break;*/

            case 'user_multi':

This code seems to be duplicated across your project.

                return new \XoopsFormSelectUser($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true);

The method getVar cannot be called on $this->targetObject (of type string).

The return type of return new \XoopsFormSelectUser($this->targetObject->vars[$key]['form_caption'], $key, false, $this->targetObject->getVar($key, 'e'), 5, true); (XoopsFormSelectUser) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'password':

This code seems to be duplicated across your project.

                return new \XoopsFormPassword($this->targetObject->vars[$key]['form_caption'], $key, 50, 255, $this->targetObject->getVar($key, 'e'));

The method getVar cannot be called on $this->targetObject (of type string).

The return type of return new \XoopsFormPassword($this->targetObject->vars[$key]['form_caption'], $key, 50, 255, $this->targetObject->getVar($key, 'e')); (XoopsFormPassword) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'country':
                return new \XoopsFormSelectCountry($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key, 'e'));

The method getVar cannot be called on $this->targetObject (of type string).

The return type of return new \XoopsFormSelectCountry($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getVar($key, 'e')); (XoopsFormSelectCountry) is incompatible with the return type documented by XoopsModules\Smartobject\Form\SmartObjectForm::getControl of type XoopsFormLabel|null.

                break;

break is not strictly necessary here and could be removed.

            case 'urllink':
//                require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformurllinkelement.php';

                return new SmartFormUrlLinkElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getUrlLinkObj($key));

The method getUrlLinkObj cannot be called on $this->targetObject (of type string).

                break;

break is not strictly necessary here and could be removed.

            case 'richfile':
//                require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformrichfileelement.php';

                return new SmartFormRichFileElement($this->targetObject->vars[$key]['form_caption'], $key, $this->targetObject->getFileObj($key));

The method getFileObj cannot be called on $this->targetObject (of type string).

                break;

break is not strictly necessary here and could be removed.

            case 'section':
//                require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/smartformsection.php';

                return new SmartFormSection($key, $this->targetObject->vars[$key]['form_caption']);
                break;

break is not strictly necessary here and could be removed.

            default:
                $classname = 'SmartForm' . ucfirst($controlName) . 'Element';
                if (!class_exists($classname)) {
                    if (file_exists(SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php')) {
//                        require_once SMARTOBJECT_ROOT_PATH . 'class/form/elements/' . strtolower($classname) . '.php';
                    } else {
                        // perhaps this is a control created by the module
                        $moduleName             = $this->targetObject->handler->_moduleName;
                        $moduleFormElementsPath = $this->targetObject->handler->_modulePath . 'class/form/elements/';
                        $classname              = ucfirst($moduleName) . ucfirst($controlName) . 'Element';
                        $classFileName          = strtolower($classname) . '.php';

                        if (file_exists($moduleFormElementsPath . $classFileName)) {
//                            require_once $moduleFormElementsPath . $classFileName;
                        } else {
                            trigger_error($classname . ' Not found', E_USER_WARNING);

                            return new \XoopsFormLabel(); //Empty object
                        }
                    }
                }

                return new $classname($this->targetObject, $key);
                break;

break is not strictly necessary here and could be removed.

        }
    }

    /**
     * @param $key
     * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor|\XoopsFormTextArea|\XoopsFormTinymce|\XoopsFormTinymce4
     */
    public function getTextArea($key)
    {
        $var = $this->targetObject->vars[$key];

        // if no control has been created, let's create a default one
        if (!isset($this->targetObject->controls[$key])) {
            $control = [
                'name'        => 'textarea',
                'itemHandler' => false,
                'method'      => false,
                'module'      => false,
                'form_editor' => 'default'
            ];
        } else {
            $control = $this->targetObject->controls[$key];
        }
        $xoops22 = Smartobject\Utility::isXoops22();

        $form_editor = isset($control['form_editor']) ? $control['form_editor'] : 'textarea';
        /**
         * If the editor is 'default', retreive the default editor of this module
         */
        if ('default' === $form_editor) {

This code seems to be duplicated across your project.

               /** @var Smartobject\Helper $helper */
            $helper = Smartobject\Helper::getInstance();
            $form_editor = null !== ($helper->getConfig('default_editor')) ? $helper->getConfig('default_editor') : 'textarea';
        }

        $caption = $var['form_caption'];
        $name    = $key;

        $value = $this->targetObject->getVar($key);

The method getVar cannot be called on $this->targetObject (of type string).

$value is not used, you could remove the assignment.

        $value = $this->targetObject->getValueFor($key, true);

The method getValueFor cannot be called on $this->targetObject (of type string).

        $editor_configs          = [];
        $editor_configs['name']  = $name;
        $editor_configs['value'] = $value;
        if ('textarea' !== $form_editor) {
            $editor_configs['rows'] = 35;
            $editor_configs['cols'] = 60;
        }

        if (isset($control['rows'])) {
            $editor_configs['rows'] = $control['rows'];
        }
        if (isset($control['cols'])) {
            $editor_configs['cols'] = $control['cols'];
        }

        $editor_configs['width']  = '100%';
        $editor_configs['height'] = '400px';

        $dhtml            = true;
        $xoopseditorclass = XOOPS_ROOT_PATH . '/class/xoopsform/formeditor.php';

        if (file_exists($xoopseditorclass)) {
            require_once $xoopseditorclass;
            $editor = new \XoopsFormEditor($caption, $form_editor, $editor_configs, $nohtml = false, $onfailure = 'textarea');
        } else {
            switch ($form_editor) {

                case 'tiny':
                    if (!$xoops22) {
                        if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php')) {
                            require_once XOOPS_ROOT_PATH . '/class/xoopseditor/tinyeditor/formtinytextarea.php';
                            $editor = new \XoopsFormTinymce([
                                                                    'caption' => $caption,
                                                                    'name'    => $name,
                                                                    'value'   => $value,
                                                                    'width'   => '100%',
                                                                    'height'  => '300px'
                                                                ], true);
                        } else {
                            if ($dhtml) {
                                $editor = new \XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
                            } else {
                                $editor = new \XoopsFormTextArea($caption, $name, $value, 7, 60);
                            }
                        }
                    } else {
                        $editor = new \XoopsFormEditor($caption, 'tinyeditor', $editor_configs);
                    }
                    break;

                case 'dhtmltextarea':
                case 'dhtmltext':
                    $editor = new \XoopsFormDhtmlTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), 20, 60);

The method getVar cannot be called on $this->targetObject (of type string).

                    if ($var['form_dsc']) {
                        $editor->setDescription($var['form_dsc']);
                    }
                    break;

//                case 'inbetween':
//                    if (!$xoops22) {
//                        if (is_readable(XOOPS_ROOT_PATH . '/class/xoopseditor/inbetween/forminbetweentextarea.php')) {
//                            require_once XOOPS_ROOT_PATH . '/class/xoopseditor/inbetween/forminbetweentextarea.php';
//                            $editor = new \XoopsFormInbetweenTextArea([
//                                                                         'caption' => $caption,
//                                                                         'name'    => $name,
//                                                                         'value'   => $value,
//                                                                         'width'   => '100%',
//                                                                         'height'  => '300px'
//                                                                     ], true);
//                        } else {
//                            if ($dhtml) {
//                                $editor = new \XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
//                            } else {
//                                $editor = new \XoopsFormTextArea($caption, $name, $value, 7, 60);
//                            }
//                        }
//                    } else {
//                        $editor = new \XoopsFormEditor($caption, 'inbetween', $editor_configs);
//                    }
//                    break;

//                case 'koivi':
//                    if (!$xoops22) {
//                        if (is_readable(XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php')) {
//                            require_once XOOPS_ROOT_PATH . '/class/wysiwyg/formwysiwygtextarea.php';
//                            $editor = new \XoopsFormWysiwygTextArea($caption, $name, $value, '100%', '400px');
//                        } else {
//                            if ($dhtml) {
//                                $editor = new \XoopsFormDhtmlTextArea($caption, $name, $value, 20, 60);
//                            } else {
//                                $editor = new \XoopsFormTextArea($caption, $name, $value, 7, 60);
//                            }
//                        }
//                    } else {
//                        $editor = new \XoopsFormEditor($caption, 'koivi', $editor_configs);
//                    }
//                    break;

//                case 'htmlarea':
//                    if (!$xoops22) {
//                        if (is_readable(XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php')) {
//                            require_once XOOPS_ROOT_PATH . '/class/htmlarea/formhtmlarea.php';
//                            $editor = new \XoopsFormHtmlarea($caption, $name, $value);
//                        }
//                    } else {
//                        $editor = new \XoopsFormEditor($caption, 'htmlarea', $editor_configs);
//                    }
//                    break;

                default:
                case 'textarea':

case 'textarea': $form_rows = isset($control['rows']) ? $control['rows'] : 5; $form_cols = isset($control['cols']) ? $control['cols'] : 60; $editor = new \XoopsFormTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), $form_rows, $form_cols); if ($var['form_dsc']) { $editor->setDescription($var['form_dsc']); } break; does not seem to be reachable.

                    $form_rows = isset($control['rows']) ? $control['rows'] : 5;
                    $form_cols = isset($control['cols']) ? $control['cols'] : 60;

                    $editor = new \XoopsFormTextArea($var['form_caption'], $key, $this->targetObject->getVar($key, 'e'), $form_rows, $form_cols);

The method getVar cannot be called on $this->targetObject (of type string).

                    if ($var['form_dsc']) {
                        $editor->setDescription($var['form_dsc']);
                    }
                    break;

            }
        }

        return $editor;
    }

    /**
     * @param                  $key
     * @param                  $var
     * @param  bool            $multiple
     * @return \XoopsFormSelect
     */
    public function getThemeSelect($key, $var, $multiple = false)
    {
        $size         = $multiple ? 5 : 1;
        $theme_select = new \XoopsFormSelect($var['form_caption'], $key, $this->targetObject->getVar($key), $size, $multiple);

The method getVar cannot be called on $this->targetObject (of type string).

        $handle  = opendir(XOOPS_THEME_PATH . '/');
        $dirlist = [];
        while (false !== ($file = readdir($handle))) {
            if (is_dir(XOOPS_THEME_PATH . '/' . $file) && !preg_match('/^[.]{1,2}$/', $file)
                && 'cvs' !== strtolower($file)) {
                $dirlist[$file] = $file;
            }
        }
        closedir($handle);
        if (!empty($dirlist)) {
            asort($dirlist);
            $theme_select->addOptionArray($dirlist);
        }

        return $theme_select;
    }

    /**
     * @param $keyname
     * @return bool
     */
    public function &getElementById($keyname)
    {
        foreach ($this->_elements as $eleObj) {
            if ($eleObj->getName() == $keyname) {
                $ret =& $eleObj;
                break;
            }
        }

        return isset($ret) ? $ret : false;
    }

    /**
     * create HTML to output the form as a theme-enabled table with validation.
     *
     * @return string
     */
    public function render()
    {
        $required = $this->getRequired();

$required is not used, you could remove the assignment.

        $ret      = "
            <form name='" . $this->getName() . "' id='" . $this->getName() . "' action='" . $this->getAction() . "' method='" . $this->getMethod() . "' onsubmit='return xoopsFormValidate_" . $this->getName() . "(this);'" . $this->getExtra() . ">

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

            <table width='100%' class='outer' cellspacing='1'>
            <tr><th colspan='2'>" . $this->getTitle() . '</th></tr>
        ';
        $hidden   = '';
        $class    = 'even';
        foreach ($this->getElements() as $ele) {
            if (!is_object($ele)) {
                $ret .= $ele;
            } elseif (!$ele->isHidden()) {
                //$class = ( $class == 'even' ) ? 'odd': 'even';
                $ret .= "<tr id='" . $ele->getName() . "' valign='top' align='left'><td class='head'>" . $ele->getCaption();
                if ('' !== $ele->getDescription()) {
                    $ret .= '<br><br><span style="font-weight: normal;">' . $ele->getDescription() . '</span>';
                }
                $ret .= "</td><td class='$class'>" . $ele->render() . "</td></tr>\n";
            } else {
                $hidden .= $ele->render();
            }
        }
        $ret .= "</table>\n$hidden\n</form>\n";
        $ret .= $this->renderValidationJS(true);

        return $ret;
    }

    /**
     * assign to smarty form template instead of displaying directly
     *
     * @param \XoopsTpl $tpl
     *
     * object
     * @param bool      $smartyName
     * @see     Smarty
     */
    public function assign(\XoopsTpl $tpl, $smartyName = false)
    {
        $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();
            $elements[$n]['section']       = strtolower(get_class($ele)) == strtolower('SmartFormSection');
            $elements[$n]['section_close'] = $ele instanceof \XoopsModules\Smartobject\Form\Elements\SmartFormSectionClose;
            $elements[$n]['hide']          = isset($this->targetObject->vars[$n]['hide']) ? $this->targetObject->vars[$n]['hide'] : false;
            if ('' !== $ele->getDescription()) {
                $elements[$n]['description'] = $ele->getDescription();
            }
            ++$i;
        }
        $js = $this->renderValidationJS();
        if (!$smartyName) {
            $smartyName = $this->getName();

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

        }

        $tpl->assign($smartyName, [
            'title'      => $this->getTitle(),
            'name'       => $this->getName(),

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

            'action'     => $this->getAction(),
            'method'     => $this->getMethod(),
            'extra'      => 'onsubmit="return xoopsFormValidate_' . $this->getName() . '(this);"' . $this->getExtra(),

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

            'javascript' => $js,
            'elements'   => $elements
        ]);
    }

    /**
     * @param  bool $withtags
     * @return string
     */
    public function renderValidationJS($withtags = true)
    {
        $js = '';
        if ($withtags) {
            $js .= "\n<!-- Start Form Validation JavaScript //-->\n<script type='text/javascript'>\n<!--//\n";
        }
        $myts     = \MyTextSanitizer::getInstance();

$myts is not used, you could remove the assignment.

        $formname = $this->getName();

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

        $js       .= "function xoopsFormValidate_{$formname}(myform) {";
        // First, output code to check required elements
        $elements = $this->getRequired();
        foreach ($elements as $elt) {
            $eltname    = $elt->getName();
            $eltcaption = trim($elt->getCaption());
            $eltmsg     = empty($eltcaption) ? sprintf(_FORM_ENTER, $eltname) : sprintf(_FORM_ENTER, $eltcaption);
            $eltmsg     = str_replace('"', '\"', stripslashes($eltmsg));
            if ('xoopsformradio' === strtolower(get_class($elt))) {
                $js .= 'var myOption = -1;';
                $js .= "for (i=myform.{$eltname}.length-1; i > -1; i--) {
                    if (myform.{$eltname}[i].checked) {
                        myOption = i; i = -1;
                    }
                }
                if (myOption == -1) {
                    window.alert(\"{$eltmsg}\"); myform.{$eltname}[0].focus(); return false; }\n";
            } elseif ('smartformselect_multielement' === strtolower(get_class($elt))) {
                $js .= 'var hasSelections = false;';
                $js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
                    if (myform['{$eltname}[]'].options[i].selected) {
                        hasSelections = true;
                    }

                }
                if (hasSelections === false) {
                    window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'].options[0].focus(); return false; }\n";
            } elseif ('xoopsformcheckbox' === strtolower(get_class($elt))
                      || 'smartformcheckelement' === strtolower(get_class($elt))) {
                $js .= 'var hasSelections = false;';
                //sometimes, there is an implicit '[]', sometimes not
                if (false === strpos($eltname, '[')) {

This code seems to be duplicated across your project.

                    $js .= "for (var i = 0; i < myform['{$eltname}[]'].length; i++) {
                        if (myform['{$eltname}[]'][i].checked) {
                            hasSelections = true;
                        }

                    }
                    if (hasSelections === false) {
                        window.alert(\"{$eltmsg}\"); myform['{$eltname}[]'][0].focus(); return false; }\n";
                } else {
                    $js .= "for (var i = 0; i < myform['{$eltname}'].length; i++) {
                        if (myform['{$eltname}'][i].checked) {
                            hasSelections = true;
                        }

                    }
                    if (hasSelections === false) {
                        window.alert(\"{$eltmsg}\"); myform['{$eltname}'][0].focus(); return false; }\n";
                }
            } else {
                $js .= "if ( myform.{$eltname}.value == \"\" ) " . "{ window.alert(\"{$eltmsg}\"); myform.{$eltname}.focus(); return false; }\n";
            }
        }
        // Now, handle custom validation code
        $elements =& $this->getElements(true);
        foreach ($elements as $elt) {
            if (method_exists($elt, 'renderValidationJS') && 'xoopsformcheckbox' !== strtolower(get_class($elt))) {
                if ($eltjs = $elt->renderValidationJS()) {
                    $js .= $eltjs . "\n";
                }
            }
        }
        $js .= "return true;\n}\n";
        if ($withtags) {
            $js .= "//--></script>\n<!-- 'End Form Validation JavaScript' //-->\n";
        }

        return $js;
    }
}