ggoffy / modulebuilder

class/Tables.php

<?php

namespace XoopsModules\Modulebuilder;

use XoopsModules\Modulebuilder;

/*
 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.
 */

/**
 * modulebuilder module.
 *
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         GNU GPL 2 (https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 *
 * @since           2.5.7
 *
 * @author          Txmod Xoops <webmaster@txmodxoops.org> - <https://xoops.org/>
 *
 */

/**
 * Class Tables.
 */
class Tables extends \XoopsObject
{
    /**
     * Options.
     */
    public $options = [
        'install',
        'index',
        'blocks',
        'admin',
        'user',
        'submenu',
        'submit',
        'tag',
        'broken',
        'search',
        'comments',
        'notifications',
        'permissions',
        'rate',
        'print',
        'pdf',
        'rss',
        'reads',
        //'single',
        //'visit',
    ];

    /**
     * @public function constructor class
     * @param null
     */
    public function __construct()
    {
        $this->initVar('table_id', XOBJ_DTYPE_INT);
        $this->initVar('table_mid', XOBJ_DTYPE_INT);
        $this->initVar('table_category', XOBJ_DTYPE_INT);
        $this->initVar('table_name', XOBJ_DTYPE_TXTBOX);
        $this->initVar('table_solename', XOBJ_DTYPE_TXTBOX);
        $this->initVar('table_fieldname', XOBJ_DTYPE_TXTBOX);
        $this->initVar('table_nbfields', XOBJ_DTYPE_INT);
        $this->initVar('table_order', XOBJ_DTYPE_INT);
        $this->initVar('table_image', XOBJ_DTYPE_TXTBOX);
        $this->initVar('table_autoincrement', XOBJ_DTYPE_INT);
        $this->initVar('table_install', XOBJ_DTYPE_INT);
        $this->initVar('table_index', XOBJ_DTYPE_INT);
        $this->initVar('table_blocks', XOBJ_DTYPE_INT);
        $this->initVar('table_admin', XOBJ_DTYPE_INT);
        $this->initVar('table_user', XOBJ_DTYPE_INT);
        $this->initVar('table_submenu', XOBJ_DTYPE_INT);
        $this->initVar('table_submit', XOBJ_DTYPE_INT);
        $this->initVar('table_tag', XOBJ_DTYPE_INT);
        $this->initVar('table_broken', XOBJ_DTYPE_INT);
        $this->initVar('table_search', XOBJ_DTYPE_INT);
        $this->initVar('table_comments', XOBJ_DTYPE_INT);
        $this->initVar('table_notifications', XOBJ_DTYPE_INT);
        $this->initVar('table_permissions', XOBJ_DTYPE_INT);
        $this->initVar('table_rate', XOBJ_DTYPE_INT);
        $this->initVar('table_print', XOBJ_DTYPE_INT);
        $this->initVar('table_pdf', XOBJ_DTYPE_INT);
        $this->initVar('table_rss', XOBJ_DTYPE_INT);
        $this->initVar('table_reads', XOBJ_DTYPE_INT);
        $this->initVar('table_single', XOBJ_DTYPE_INT);
        $this->initVar('table_visit', XOBJ_DTYPE_INT);
    }

    /**
     * @param string $method
     * @param array  $args
     *
     * @return mixed
     */
    public function __call($method, $args)
    {
        $arg = isset($args[0]) ? $args[0] : null;

        return $this->getVar($method, $arg);
    }

    /**
     * @static function getInstance
     * @param null
     * @return Tables
     */
    public static function getInstance()
    {
        static $instance = false;
        if (!$instance) {
            $instance = new self();
        }

        return $instance;
    }

    /**
     * @static function getFormTables
     * @param mixed $action
     *
     * @return \XoopsThemeForm
     */
    public function getFormTables($action = false)
    {
        if (false === $action) {
            $action = \Xmf\Request::getString('REQUEST_URI', '', 'SERVER');
        }
        $helper    = Modulebuilder\Helper::getInstance();
        $isNew     = $this->isNew();
        $tableName = $this->getVar('table_name');
        $tableMid  = $this->getVar('table_mid');
        $title     = $isNew ? \sprintf(\_AM_MODULEBUILDER_TABLES_NEW) : \sprintf(\_AM_MODULEBUILDER_TABLES_EDIT);

        \xoops_load('XoopsFormLoader');
        $form = new \XoopsThemeForm($title, 'tableform', $action, 'post', true);
        $form->setExtra('enctype="multipart/form-data"');

        $modules       = $helper->getHandler('Modules')->getObjects(null);
        $modulesSelect = new \XoopsFormSelect(\_AM_MODULEBUILDER_TABLE_MODULES, 'table_mid', $tableMid);
        $modulesSelect->addOption('', \_AM_MODULEBUILDER_TABLE_MODSELOPT);
        foreach ($modules as $mod) {
            $modulesSelect->addOption($mod->getVar('mod_id'), $mod->getVar('mod_name'));
        }
        $form->addElement($modulesSelect, true);

        $tableNameText = new \XoopsFormText(\_AM_MODULEBUILDER_TABLE_NAME, 'table_name', 40, 150, $tableName);

It seems like $tableName can also be of type array and array; however, parameter $value of XoopsFormText::__construct() does only seem to accept string, maybe add an additional type check?

        $tableNameText->setDescription(\_AM_MODULEBUILDER_TABLE_NAME_DESC);
        $form->addElement($tableNameText, true);

        $tableSoleNameText = new \XoopsFormText(\_AM_MODULEBUILDER_TABLE_SOLENAME, 'table_solename', 40, 150, $this->getVar('table_solename'));
        $tableSoleNameText->setDescription(\_AM_MODULEBUILDER_TABLE_SOLENAME_DESC);
        $form->addElement($tableSoleNameText, true);

        $radioCategory = $isNew ? 0 : $this->getVar('table_category');
        $category      = new \XoopsFormRadioYN(\_AM_MODULEBUILDER_TABLE_CATEGORY, 'table_category', $radioCategory);

It seems like $radioCategory can also be of type array and array; however, parameter $value of XoopsFormRadioYN::__construct() does only seem to accept string, maybe add an additional type check?

        $category->setDescription(\_AM_MODULEBUILDER_TABLE_CATEGORY_DESC);
        $form->addElement($category);

        $tableFieldname = new \XoopsFormText(\_AM_MODULEBUILDER_TABLE_FIELDNAME, 'table_fieldname', 30, 50, $this->getVar('table_fieldname'));
        $tableFieldname->setDescription(\_AM_MODULEBUILDER_TABLE_FIELDNAME_DESC);
        $form->addElement($tableFieldname);

        $tableNumbFileds = new \XoopsFormText(\_AM_MODULEBUILDER_TABLE_NBFIELDS, 'table_nbfields', 10, 25, $this->getVar('table_nbfields'));
        $tableNumbFileds->setDescription(\_AM_MODULEBUILDER_TABLE_NBFIELDS_DESC);
        $form->addElement($tableNumbFileds, true);

        if (!$isNew) {
            $tableOrder = new \XoopsFormText(\_AM_MODULEBUILDER_TABLE_ORDER, 'table_order', 5, 10, $this->getVar('table_order'));
            $tableOrder->setDescription(\_AM_MODULEBUILDER_TABLE_ORDER_DESC);
            $form->addElement($tableOrder, true);
        }

        $getTableImage    = $this->getVar('table_image');
        $tableImage       = $getTableImage ?: 'blank.gif';
        $icons32Directory = '/Frameworks/moduleclasses/icons/32';
        $uploadsDirectory = '/uploads/modulebuilder/images/tables';
        $iconsDirectory   = \is_dir(\XOOPS_ROOT_PATH . $icons32Directory) ? $icons32Directory : $uploadsDirectory;

        $imgtray1     = new \XoopsFormElementTray(\_AM_MODULEBUILDER_TABLE_IMAGE, '<br>');
        $imgpath1     = \sprintf(\_AM_MODULEBUILDER_FORMIMAGE_PATH, ".{$iconsDirectory}/");
        $imageSelect1 = new \XoopsFormSelect($imgpath1, 'table_image', $tableImage, 10);
        $imageArray1  = \XoopsLists::getImgListAsArray(\XOOPS_ROOT_PATH . $iconsDirectory);
        foreach ($imageArray1 as $image1) {
            $imageSelect1->addOption($image1, $image1);
        }
        $imageSelect1->setExtra("onchange='showImgSelected(\"image1\", \"table_image\", \"" . $iconsDirectory . '", "", "' . \XOOPS_URL . "\")'");
        $imgtray1->addElement($imageSelect1, false);
        $imgtray1->addElement(new \XoopsFormLabel('', "<br><img src='" . \XOOPS_URL . '/' . $iconsDirectory . '/' . $tableImage . "' id='image1' alt='' />"));
        $fileseltray1 = new \XoopsFormElementTray('', '<br>');
        $fileseltray1->addElement(new \XoopsFormFile(\_AM_MODULEBUILDER_FORMUPLOAD, 'attachedfile', $helper->getConfig('maxsize_image')));
        $fileseltray1->addElement(new \XoopsFormLabel(''));
        $imgtray1->addElement($fileseltray1);
        $imgtray1->setDescription(\_AM_MODULEBUILDER_TABLE_IMAGE_DESC);
        $form->addElement($imgtray1);

        $tableAutoincrement      = $this->isNew() ? 1 : $this->getVar('table_autoincrement');
        $checkTableAutoincrement = new \XoopsFormRadioYN(\_AM_MODULEBUILDER_TABLE_AUTO_INCREMENT, 'table_autoincrement', $tableAutoincrement);
        $checkTableAutoincrement->setDescription(\_AM_MODULEBUILDER_TABLE_AUTO_INCREMENT_DESC);
        $form->addElement($checkTableAutoincrement);

        $optionsTray = new \XoopsFormElementTray(_OPTIONS, '<br>');

        $tableCheckAll = new \XoopsFormCheckBox('', 'tablebox', 1);
        $tableCheckAll->addOption('allbox', \_AM_MODULEBUILDER_TABLE_ALL);
        $tableCheckAll->setExtra(' onclick="xoopsCheckAll(\'tableform\', \'tablebox\');" ');
        $tableCheckAll->setClass('xo-checkall');
        $optionsTray->addElement($tableCheckAll);
        // Options
        $checkbox = new \XoopsFormCheckbox(' ', 'table_option', $this->getOptionsTables(), '<br>');
        $checkbox->setDescription(\_AM_MODULEBUILDER_OPTIONS_DESC);
        foreach ($this->options as $option) {
            $checkbox->addOption($option, self::getDefinedLanguage('\_AM_MODULEBUILDER_TABLE_' . \mb_strtoupper($option)));
        }
        $optionsTray->addElement($checkbox);

        $optionsTray->setDescription(\_AM_MODULEBUILDER_TABLE_OPTIONS_CHECKS_DESC);

        $form->addElement($optionsTray);

        $buttonTray = new \XoopsFormElementTray(_REQUIRED . ' <sup class="red bold">*</sup>', '');
        $buttonTray->addElement(new \XoopsFormHidden('op', 'save'));
        $buttonTray->addElement(new \XoopsFormHidden('table_id', ($isNew ? 0 : $this->getVar('table_id'))));

It seems like $isNew ? 0 : $this->getVar('table_id') can also be of type array and array; however, parameter $value of XoopsFormHidden::__construct() does only seem to accept string, maybe add an additional type check?

        $buttonTray->addElement(new \XoopsFormButton('', 'submit', \_SUBMIT, 'submit'));
        $form->addElement($buttonTray);

        return $form;
    }

    /**
     * Get Values.
     *
     * @param null $keys

Are you sure the doc-type for parameter $keys is correct as it would always require null to be passed?

     * @param null $format

Are you sure the doc-type for parameter $format is correct as it would always require null to be passed?

     * @param null $maxDepth

Are you sure the doc-type for parameter $maxDepth is correct as it would always require null to be passed?

     *
     * @return array
     */
    public function getValuesTables($keys = null, $format = null, $maxDepth = null)
    {
        $helper = Modulebuilder\Helper::getInstance();

        $ret = $this->getValues($keys, $format, $maxDepth);
        // Values
        $ret['id']  = $this->getVar('table_id');
        $ret['mid'] = $this->getVar('table_mid');
        $modulesObj = $helper->getHandler('Modules')->get($ret['mid']);
        if (\is_object($modulesObj)) {
            $ret['module'] = $modulesObj->getVar('mod_name');
        }
        $ret['name']          = \ucfirst($this->getVar('table_name'));
        $ret['image']         = $this->getVar('table_image');
        $ret['nbfields']      = $this->getVar('table_nbfields');
        $ret['order']         = $this->getVar('table_order');
        $ret['blocks']        = $this->getVar('table_blocks');
        $ret['admin']         = $this->getVar('table_admin');
        $ret['user']          = $this->getVar('table_user');
        $ret['submenu']       = $this->getVar('table_submenu');
        $ret['search']        = $this->getVar('table_search');
        $ret['comments']      = $this->getVar('table_comments');
        $ret['notifications'] = $this->getVar('table_notifications');
        $ret['permissions']   = $this->getVar('table_permissions');

        return $ret;
    }

    /**
     * Get Options.
     *
     * @return array
     */
    public function getOptionsTables()
    {
        $retTable = [];
        foreach ($this->options as $option) {
            if (1 == $this->getVar('table_' . $option)) {
                $retTable[] = $option;
            }
        }

        return $retTable;
    }

    /**
     * Get Defined Language.
     *
     * @param $lang
     *
     * @return string
     */
    private static function getDefinedLanguage($lang)
    {
        if (\defined($lang)) {
            return \constant($lang);
        }

        return $lang;
    }
}