XoopsModules\Mymenus\LinksUtility

Complexity

Total Complexity

28

Size/Duplication

Total Lines	316
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	listLinks()	0	28	3
A	moveLink()	0	11	1
A	toggleLinkVisibility()	0	17	2
B	editLink()	0	118	8
B	addLink()	0	55	7
B	saveLink()	0	41	7

<?php namespace XoopsModules\Mymenus;

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

/**
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         http://www.gnu.org/licenses/gpl-2.0.html GNU Public License
 * @package         Mymenus
 * @since           1.0
 * @author          trabis <lusopoemas@gmail.com>, bleekk <bleekk@outlook.com>
 */

use Xmf\Request;

The type Xmf\Request was not found. Maybe you did not declare it correctly or list all dependencies?

use XoopsModules\Mymenus;

/**
 * Class LinksUtility
 */
class LinksUtility
{

    /**
     * Display the links in a menu
     *
     * @param integer $start
     * @param integer $mid
     *
     * @return bool|mixed|string
     */
    public static function listLinks($start = 0, $mid)
    {
        /** @var \XoopsModules\Mymenus\Helper $helper */
        $helper = \XoopsModules\Mymenus\Helper::getInstance();

        global $mymenusTpl;
        //
        $linksCriteria = new \CriteriaCompo(new \Criteria('mid', (int)$mid));

The type Criteria was not found. Maybe you did not declare it correctly or list all dependencies?

The type CriteriaCompo was not found. Maybe you did not declare it correctly or list all dependencies?

        $linksCount    = $helper->getHandler('Links')->getCount($linksCriteria);
        $mymenusTpl->assign('count', $linksCount);
        //
        $linksCriteria->setSort('weight');
        $linksCriteria->setOrder('ASC');
        //
        //        $menusArray = array();
        if (($linksCount > 0) && ($linksCount >= (int)$start)) {
            $linksCriteria->setStart((int)$start);
            $linksArrays = $helper->getHandler('Links')->getObjects($linksCriteria, false, false); // as array
            //
            $menuBuilder = new Mymenus\Builder($linksArrays);
            $menusArray  = $menuBuilder->render();
            $mymenusTpl->assign('menus', $menusArray); // not 'menus', 'links' shoult be better
        }
        //
        $mymenusTpl->assign('addform', self::editLink(null, null, $mid));

        //
        return $mymenusTpl->fetch($GLOBALS['xoops']->path("modules/{$helper->getDirname()}/templates/static/mymenus_admin_links.tpl"));
    }

    /**
     * @param $mid
     */
    public static function addLink($mid)
    {
        /** @var \XoopsModules\Mymenus\Helper $helper */
        $helper = \XoopsModules\Mymenus\Helper::getInstance();
        //
        if (!$GLOBALS['xoopsSecurity']->check()) {
            redirect_header($GLOBALS['mymenusAdminPage'], 3, implode('<br>', $GLOBALS['xoopsSecurity']->getErrors()));

The function redirect_header was not found. Maybe you did not declare it correctly or list all dependencies?

        }
        if (!$mid) {
            redirect_header($GLOBALS['mymenusAdminPage'] . '?op=list', 2, _AM_MYMENUS_MSG_MENU_INVALID_ERROR);
        }
        //
        $linksCiteria = new \CriteriaCompo(new \Criteria('mid', $mid));
        $linksCiteria->setSort('weight');
        $linksCiteria->setOrder('DESC');
        $linksCiteria->setLimit(1);
        $linksObjs = $helper->getHandler('Links')->getObjects($linksCiteria);
        $weight    = 1;
        if (isset($linksObjs[0]) && ($linksObjs[0] instanceof \XoopsModules\Mymenus\Links)) {
            $weight = $linksObjs[0]->getVar('weight') + 1;
        }

        $newLinksObj = $helper->getHandler('Links')->create();
        //    if (!isset($_POST['hooks'])) {
        //        $_POST['hooks'] = array();
        //    }
        if (!Request::getArray('hooks', null, 'POST')) {
            $_POST['hooks'] = [];
        }
        // clean incoming POST vars
        $newLinksObj->setVar('id', Request::getInt('id',0,'POST'));
        $newLinksObj->setVar('pid', Request::getInt('pid',0,'POST'));
        $newLinksObj->setVar('mid', Request::getInt('mid',0,'POST'));
        $newLinksObj->setVar('title', Request::getString('title','','POST'));
        $newLinksObj->setVar('alt_title',  Request::getString('alt_title','','POST'));
        $newLinksObj->setVar('visible', Request::getInt('visible',0,'POST'));
        $newLinksObj->setVar('link',  Request::getString('link','','POST'));
        $newLinksObj->setVar('weight', Request::getInt('weight',0,'POST'));
        $newLinksObj->setVar('target', Request::getString('target','','POST'));
        $newLinksObj->setVar('groups', Request::getArray('groups', [], 'POST'));
        $newLinksObj->setVar('hooks', Request::getArray('hooks', [], 'POST'));
        $newLinksObj->setVar('image', Request::getString('image','','POST'));
        $newLinksObj->setVar('css', Request::getString('css','','POST'));
        
        $newLinksObj->setVar('weight', $weight);
        /** @var  \XoopsModules\Mymenus\LinksHandler $linksHandler */
        $linksHandler = $helper->getHandler('Links');
        if (!$linksHandler->insert($newLinksObj)) {
            $msg = _AM_MYMENUS_MSG_ERROR;
        } else {
            $linksHandler->updateWeights($newLinksObj);
            $msg = _AM_MYMENUS_MSG_SUCCESS;
        }

        redirect_header($GLOBALS['mymenusAdminPage'] . '?op=list&mid=' . $newLinksObj->getVar('mid'), 2, $msg);
    }

    /**
     * @param integer $id
     * @param integer $mid
     */
    public static function saveLink($id, $mid)
    {
        /** @var \XoopsModules\Mymenus\Helper $helper */
        $helper = \XoopsModules\Mymenus\Helper::getInstance();
        /** @var  \XoopsModules\Mymenus\LinksHandler $linksHandler */
        $linksHandler = $helper->getHandler('Links');
        //
        if (!$GLOBALS['xoopsSecurity']->check()) {
            redirect_header($GLOBALS['mymenusAdminPage'], 3, implode('<br>', $GLOBALS['xoopsSecurity']->getErrors()));

The function redirect_header was not found. Maybe you did not declare it correctly or list all dependencies?

        }
        if (!$mid) {
            redirect_header($GLOBALS['mymenusAdminPage'] . '?op=list', 2, _AM_MYMENUS_MSG_MENU_INVALID_ERROR);
        }
        //
        $mid      = (int)$mid;
        $linksObj = $linksHandler->get((int)$id);

        //if this was moved then parent could be in different menu, if so then set parent to top level
        if (Request::getInt('pid', '', 'POST')) {
            $parentLinksObj = $linksHandler->get($linksObj->getVar('pid'));  //get the parent object
            if (($parentLinksObj instanceof \XoopsModules\Mymenus\Links)
                && ($linksObj->getVar('mid') != $parentLinksObj->getVar('mid'))) {
                $linksObj->setVar('pid', 0);
            }
        }
        // Disable xoops debugger in dialog window
        xoops_load('xoopslogger');

The function xoops_load was not found. Maybe you did not declare it correctly or list all dependencies?

        $xoopsLogger            = \XoopsLogger::getInstance();

The type XoopsLogger was not found. Maybe you did not declare it correctly or list all dependencies?

        $xoopsLogger->activated = false;
        error_reporting(0);

        // @TODO: clean incoming POST vars
        $linksObj->setVars($_POST);

        if (!$linksHandler->insert($linksObj)) {
            $msg = _AM_MYMENUS_MSG_ERROR;
        } else {
            $msg = _AM_MYMENUS_MSG_SUCCESS;
        }

        redirect_header($GLOBALS['mymenusAdminPage'] . "?op=list&mid={$mid}", 2, $msg);
    }

    /**
     * @param null  $id

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

     * @param null  $pid

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

     *
     * @param  null $mid

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

     * @return string
     */
    public static function editLink($id = null, $pid = null, $mid = null)
    {
        /** @var \XoopsModules\Mymenus\Helper $helper */
        $helper = \XoopsModules\Mymenus\Helper::getInstance();
        //
        // Disable xoops debugger in dialog window
        xoops_load('xoopslogger');

The function xoops_load was not found. Maybe you did not declare it correctly or list all dependencies?

        $xoopsLogger            = \XoopsLogger::getInstance();
        $xoopsLogger->activated = false;
        error_reporting(0);

        $pathIcon16      = \Xmf\Module\Admin::iconUrl('', 16);

The type Xmf\Module\Admin was not found. Maybe you did not declare it correctly or list all dependencies?

        //        $registry = MymenusRegistry::getInstance();
        //        $plugin   = MymenusPlugin::getInstance();

        $linksObj = $helper->getHandler('Links')->get((int)$id);

        if ($linksObj->isNew()) {
            $formTitle = _ADD;

The constant XoopsModules\Mymenus\_ADD was not found. Maybe you did not declare it correctly or list all dependencies?

            if (null !== $pid) {
                $linksObj->setVar('pid', (int)$pid);
            }
            if (null !== $mid) {
                $linksObj->setVar('mid', (int)$mid);
            }
        } else {
            $formTitle = _EDIT;

The constant XoopsModules\Mymenus\_EDIT was not found. Maybe you did not declare it correctly or list all dependencies?

        }
        $form = new \XoopsThemeForm($formTitle, 'admin_form', $GLOBALS['mymenusAdminPage'], 'post', true);

The type XoopsThemeForm was not found. Maybe you did not declare it correctly or list all dependencies?

        // links: title
        $formtitle = new \XoopsFormText(_AM_MYMENUS_MENU_TITLE, 'title', 50, 255, $linksObj->getVar('title'));

The type XoopsFormText was not found. Maybe you did not declare it correctly or list all dependencies?

        $form->addElement($formtitle, true);
        // links: alt_title
        $formalttitle = new \XoopsFormText(_AM_MYMENUS_MENU_ALTTITLE, 'alt_title', 50, 255, $linksObj->getVar('alt_title'));
        $form->addElement($formalttitle);
        // links: mid
        $menusCriteria = new \CriteriaCompo();
        $menusCriteria->setSort('title');
        $menusCriteria->setOrder('ASC');
        $menusList = $helper->getHandler('Menus')->getList($menusCriteria);
        if (count($menusList) > 1) {
            // display menu options (if more than 1 menu available
            if (!$linksObj->getVar('mid')) { // initial menu value not set
                //                $menuValues = array_flip($menusList);
                $formmid = new \XoopsFormSelect(_AM_MYMENUS_MENU_MENU, 'mid', $mid);//array_shift($menuValues));

The type XoopsFormSelect was not found. Maybe you did not declare it correctly or list all dependencies?

            } else {
                $formmid = new \XoopsFormSelect(_AM_MYMENUS_MENU_MENU, 'mid', $linksObj->getVar('mid'));
            }
            $formmid->addOptionArray($menusList);
        } else {
            $menuKeys  = array_keys($menusList);
            $menuTitle = array_shift($menusList);
            $formmid   = new \XoopsFormElementTray('Menu');

The type XoopsFormElementTray was not found. Maybe you did not declare it correctly or list all dependencies?

            $formmid->addElement(new \XoopsFormHidden('mid', $menuKeys[0]));

The type XoopsFormHidden was not found. Maybe you did not declare it correctly or list all dependencies?

            $formmid->addElement(new \XoopsFormLabel('', $menuTitle, 'menuTitle'));

The type XoopsFormLabel was not found. Maybe you did not declare it correctly or list all dependencies?

        }
        $form->addElement($formmid);
        // links: link
        $formlink = new \XoopsFormText(_AM_MYMENUS_MENU_LINK, 'link', 50, 255, $linksObj->getVar('link'));
        $form->addElement($formlink);
        // links: image
        $formimage = new \XoopsFormText(_AM_MYMENUS_MENU_IMAGE, 'image', 50, 255, $linksObj->getVar('image'));
        $form->addElement($formimage);
        //
        //$form->addElement($formparent);
        // links: visible
        $statontxt  = "&nbsp;<img src='{$pathIcon16}/1.png' alt='" . _YES . "'>&nbsp;" . _YES . '&nbsp;&nbsp;&nbsp;';

The constant XoopsModules\Mymenus\_YES was not found. Maybe you did not declare it correctly or list all dependencies?

        $statofftxt = "&nbsp;<img src='{$pathIcon16}/0.png' alt='" . _NO . "'>&nbsp;" . _NO . '&nbsp;';

The constant XoopsModules\Mymenus\_NO was not found. Maybe you did not declare it correctly or list all dependencies?

        $formvis    = new \XoopsFormRadioYN(_AM_MYMENUS_MENU_VISIBLE, 'visible', $linksObj->getVar('visible'), $statontxt, $statofftxt);

The type XoopsFormRadioYN was not found. Maybe you did not declare it correctly or list all dependencies?

        $form->addElement($formvis);
        // links: target
        $formtarget = new \XoopsFormSelect(_AM_MYMENUS_MENU_TARGET, 'target', $linksObj->getVar('target'));
        $formtarget->addOption('_self', _AM_MYMENUS_MENU_TARG_SELF);
        $formtarget->addOption('_blank', _AM_MYMENUS_MENU_TARG_BLANK);
        $formtarget->addOption('_parent', _AM_MYMENUS_MENU_TARG_PARENT);
        $formtarget->addOption('_top', _AM_MYMENUS_MENU_TARG_TOP);
        $form->addElement($formtarget);
        // links: groups
        $formgroups = new \XoopsFormSelectGroup(_AM_MYMENUS_MENU_GROUPS, 'groups', true, $linksObj->getVar('groups'), 5, true);

The type XoopsFormSelectGroup was not found. Maybe you did not declare it correctly or list all dependencies?

        $formgroups->setDescription(_AM_MYMENUS_MENU_GROUPS_HELP);
        $form->addElement($formgroups);
        // @TODO: reintroduce hooks
        /*
            //links: hooks
            $formhooks = new \XoopsFormSelect(_AM_MYMENUS_MENU_ACCESS_FILTER, "hooks", $linksObj->getVar('hooks'), 5, true);
            $plugin->triggerEvent('AccessFilter');
            $results = $registry->getEntry('accessFilter');
            if ($results) {
                foreach ($results as $result) {
                    $formhooks->addOption($result['method'], $result['name']);
                }
            }
            $form->addElement($formhooks);
        */
        // links: css
        $formcss = new \XoopsFormText(_AM_MYMENUS_MENU_CSS, 'css', 50, 255, $linksObj->getVar('css'));
        $form->addElement($formcss);
        //
        $buttonTray = new \XoopsFormElementTray('', '');
        $buttonTray->addElement(new \XoopsFormButton('', 'submit_button', _SUBMIT, 'submit'));

The constant XoopsModules\Mymenus\_SUBMIT was not found. Maybe you did not declare it correctly or list all dependencies?

The type XoopsFormButton was not found. Maybe you did not declare it correctly or list all dependencies?

        $button = new \XoopsFormButton('', 'reset', _CANCEL, 'button');

The constant XoopsModules\Mymenus\_CANCEL was not found. Maybe you did not declare it correctly or list all dependencies?

        if (null !== $id) {
            $button->setExtra("onclick=\"document.location.href='" . $GLOBALS['mymenusAdminPage'] . "?op=list&mid={$mid}'\"");
        } else {
            $button->setExtra("onclick=\"document.getElementById('addform').style.display = 'none'; return false;\"");
        }
        $buttonTray->addElement($button);
        $form->addElement($buttonTray);

        if (null !== $id) {
            $form->addElement(new \XoopsFormHidden('op', 'save'));
            $form->addElement(new \XoopsFormHidden('id', $id));
        } else {
            $form->addElement(new \XoopsFormHidden('op', 'add'));
        }

        return $form->render();
    }

    /**
     *
     * Update the {@see MymenusLinks} weight (order)
     *
     * @param integer $id of links object
     * @param integer $weight
     */
    public static function moveLink($id, $weight)
    {
        /** @var \XoopsModules\Mymenus\Helper $helper */
        $helper = \XoopsModules\Mymenus\Helper::getInstance();
        /** @var Mymenus\LinksHandler $linksHandler */
        $linksHandler = $helper->getHandler('Links');
        //
        $linksObj = $linksHandler->get((int)$id);
        $linksObj->setVar('weight', (int)$weight);
        $linksHandler->insert($linksObj);
        $linksHandler->updateWeights($linksObj);
    }

    /**
     * @param $id
     * @param $visible
     */
    public static function toggleLinkVisibility($id, $visible)

The parameter $visible is not used and could be removed.

    {
        /** @var \XoopsModules\Mymenus\Helper $helper */
        $helper = \XoopsModules\Mymenus\Helper::getInstance();
        /** @var  \XoopsModules\Mymenus\LinksHandler $linksHandler */
        $linksHandler = $helper->getHandler('Links');
        // Disable xoops debugger in dialog window
        xoops_load('xoopslogger');

The function xoops_load was not found. Maybe you did not declare it correctly or list all dependencies?

        $xoopsLogger            = \XoopsLogger::getInstance();
        $xoopsLogger->activated = false;
        error_reporting(0);
        //
        $linksObj = $linksHandler->get((int)$id);
        $visible  = (1 === $linksObj->getVar('visible')) ? 0 : 1;
        $linksObj->setVar('visible', $visible);
        $linksHandler->insert($linksObj);
        echo $linksObj->getVar('visible');
    }
}