XoopsModule::id() - Code Metrics - Inspection of "Automatic autoload for modules" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#594)

by Richard
created 2019-05-11 23:38 UTC
XoopsModule::id() A

↳ Parent: XoopsModule
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
ccs	2
cts	2
cp	1
crap	1
<?php
/**
 * XOOPS Kernel Class
 *
 * 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 (http://xoops.org)
 * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package         kernel
 * @since           2.0.0
 * @version         $Id$
 */

namespace Xoops\Core\Kernel\Handlers;

use Xoops\Core\XoopsArray;
use Xoops\Core\Kernel\Dtype;
use Xoops\Core\Kernel\XoopsObject;

/**
 * A Module
 *
 * @category  Xoops\Core\Kernel\XoopsModule
 * @package   Xoops\Core\Kernel
 * @author    Kazumi Ono <[email protected]>
 * @author    Taiwen Jiang <[email protected]>
 * @copyright 2000-2019 XOOPS Project (https://xoops.org)
 * @license   GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 */
class XoopsModule extends XoopsObject
{
    /**
     * @var array
     */
    public $modinfo;

    /**
     * @var array
     */
    public $adminmenu;
    /**
    *
    * @var array
    */
    private $internalMessages = array();

    protected $xoops_url;
    protected $xoops_root_path;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->initVar('mid', Dtype::TYPE_INTEGER, null, false);
        $this->initVar('name', Dtype::TYPE_TEXT_BOX, null, true, 150);
        $this->initVar('version', Dtype::TYPE_INTEGER, 100, false);
        $this->initVar('last_update', Dtype::TYPE_INTEGER, null, false);
        $this->initVar('weight', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('isactive', Dtype::TYPE_INTEGER, 1, false);
        $this->initVar('dirname', Dtype::TYPE_TEXT_BOX, null, true);
        $this->initVar('hasmain', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('hasadmin', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('hassearch', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('hasconfig', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('hascomments', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('hasnotification', Dtype::TYPE_INTEGER, 0, false);
        $this->initVar('namespace', Dtype::TYPE_TEXT_BOX, null, true);
        $this->initVar('category', Dtype::TYPE_TEXT_BOX, null, true);

        $this->xoops_url = \XoopsBaseConfig::get('url');
        $this->xoops_root_path = \XoopsBaseConfig::get('root-path');
    }

    /**
     * Load module info
     *
     * @param string  $dirname module directory
     * @param boolean $verbose true for more information
     *
     * @return void
     * @todo module 'version' should be semver based -- 1.0.0 should be OK, not an error
     */
    public function loadInfoAsVar($dirname, $verbose = true)
    {
        $dirname = basename($dirname);
        if (!isset($this->modinfo)) {
            if (false === $this->loadInfo($dirname, $verbose)) {
                return;
            }
        }

        $modInfoArray = new XoopsArray($this->modinfo);
        $this->setVar('name', $modInfoArray->get('name'));
        // see @todo
        $versionPieces = explode('.', $this->modinfo['version']);
        if (count($versionPieces) > 2) {
            $this->modinfo['version'] = $versionPieces[0].'.'.$versionPieces[1];
        }
        $this->setVar('version', (int)(100 * ($this->modinfo['version'] + 0.001)));
        $this->setVar('dirname', $this->modinfo['dirname']);

        $this->setVar('hasmain', (bool) $modInfoArray->get('hasmain', false));
        $this->setVar('hasadmin', (bool) $modInfoArray->get('hasadmin', false));
        $this->setVar('hassearch', (bool) $modInfoArray->get('hassearch', false));
        $this->setVar('hasconfig', ($modInfoArray->has('config') && is_array($modInfoArray->get('config'))) || (bool) $modInfoArray->get('hascomments', false));
        $this->setVar('hascomments', (bool) $modInfoArray->get('hascomments', false));
        $this->setVar('hasnotification', (bool) $modInfoArray->get('hasnotification', false));
        $this->setVar('namespace', $modInfoArray->get('namespace'));
        $this->setVar('category', $modInfoArray->get('category'));
    }

    /**
     * add a message
     *
     * @param string $str message to add
     *
     * @return void
     */
    public function setMessage($str)
    {
        $this->internalMessages[] = trim($str);
    }

    /**
     * return the messages for this object as an array
     *
     * @return array an array of messages
     */
    public function getMessages()
    {
        return $this->internalMessages;
    }

    /**
     * Set module info
     *
     * @param string $name  name
     * @param mixed  $value value
     *
     * @return  bool
     **/
    public function setInfo($name, $value)
    {
        if (empty($name)) {
            $this->modinfo = $value;
        } else {
            $this->modinfo[$name] = $value;
        }
        return true;
    }

    /**
     * Get module info
     *
     * @param string $name If $name is set, returns a single module information item as string.
     *
     * @return string[]|string Array of module information, or just the single name requested
     */
    public function getInfo($name = null)
    {
        if (!isset($this->modinfo)) {
            $this->loadInfo($this->getVar('dirname'));
            $this->loadInfo(/** @scrutinizer ignore-type */ $this->getVar('dirname'));
        }
        if (isset($name)) {
            if (isset($this->modinfo[$name])) {
                return $this->modinfo[$name];
            }
            $return = false;
            return $return;

        }
        return $this->modinfo;
    }

    /**
     * Get a link to the modules main page
     *
     * @return string|false FALSE on fail
     */
    public function mainLink()
    {
        if ($this->getVar('hasmain') == 1) {
            $ret = '<a href="' . $this->xoops_url . '/modules/' . $this->getVar('dirname') . '/">'
                . $this->getVar('name') . '</a>';
            return $ret;
        }
        return false;
    }

    /**
     * Get links to the subpages
     *
     * @return string
     */
    public function subLink()
    {
        $ret = array();
        if ($this->getInfo('sub') && is_array($this->getInfo('sub'))) {
            foreach ($this->getInfo('sub') as $submenu) {
                $ret[] = array(
                    'name' => $submenu['name'] ,
                    'url' => $submenu['url']);
            }
        }
        return $ret;

    }

    /**
     * Load the admin menu for the module
     *
     * @return void
     */
    public function loadAdminMenu()
    {
        $file = $this->xoops_root_path . '/modules/' . $this->getInfo('dirname') . '/' . $this->getInfo('adminmenu');
        $file = $this->xoops_root_path . '/modules/' . /** @scrutinizer ignore-type */ $this->getInfo('dirname') . '/' . $this->getInfo('adminmenu');
        if ($this->getInfo('adminmenu') && $this->getInfo('adminmenu') != '' && \XoopsLoad::fileExists($file)) {
            $adminmenu = array();
            include $file;
            $this->adminmenu = $adminmenu;
        }
    }

    /**
     * Get the admin menu for the module
     *
     * @return string
     */
    public function getAdminMenu()
    {
        if (!isset($this->adminmenu)) {
            $this->loadAdminMenu();
        }
        return $this->adminmenu;

    }

    /**
     * Load the module info for this module
     *
     * @param string $dirname Module directory
     * @param bool   $verbose Give an error on fail?
     *
     * @return bool
     *
     * @todo the $modVersions array should be built once when modules are installed/updated and then cached
     */
    public function loadInfo($dirname, $verbose = true)
    {
        static $modVersions;
        if (empty($dirname)) {
            return false;
        }
        $dirname = basename($dirname);
        if (isset($modVersions[$dirname])) {
            $this->modinfo = $modVersions[$dirname];
            return true;
        }
        $xoops = \Xoops::getInstance();
        $dirname = basename($dirname);
        $xoops->loadLanguage('modinfo', $dirname);
        $xoops->loadLocale($dirname);

        if (!\XoopsLoad::fileExists($file = $xoops->path('modules/' . $dirname . '/xoops_version.php'))) {
            if (false != $verbose) {

                echo "Module File for $dirname Not Found!";
            }
            return false;
        }
        $modversion = array();
        include $file;
        $modVersions[$dirname] = $modversion;
        $this->modinfo = $modVersions[$dirname];
        return true;
    }

    /**
     * getter for mid
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function id($format = 'n')
    {
        return $this->getVar('mid', $format);
    }

    /**
     * another getter for mid
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function mid($format = '')
    {
        return $this->getVar('mid', $format);
    }

    /**
     * getter for module name
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function name($format = '')
    {
        return $this->getVar('name', $format);
    }

    /**
     * getter for module version
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function version($format = '')
    {
        return $this->getVar('version', $format);
    }

    /**
     * getter for module last update
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function last_update($format = '')
    {
        return $this->getVar('last_update', $format);
    }

    /**
     * getter for weight
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function weight($format = '')
    {
        return $this->getVar('weight', $format);
    }

    /**
     * getter for isactive
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function isactive($format = '')
    {
        return $this->getVar('isactive', $format);
    }

    /**
     * getter for dirname
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function dirname($format = '')
    {
        return $this->getVar('dirname', $format);
    }

    /**
     * getter for hasmain
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function hasmain($format = '')
    {
        return $this->getVar('hasmain', $format);
    }

    /**
     * getter for hasadmin
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function hasadmin($format = '')
    {
        return $this->getVar('hasadmin', $format);
    }

    /**
     * getter for hassearch
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function hassearch($format = '')
    {
        return $this->getVar('hassearch', $format);
    }

    /**
     * getter for hasconfig
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function hasconfig($format = '')
    {
        return $this->getVar('hasconfig', $format);
    }

    /**
     * getter for hascomments
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function hascomments($format = '')
    {
        return $this->getVar('hascomments', $format);
    }

    /**
     * getter for hasnotifications
     *
     * @param string $format Dtype::FORMAT_xxxx constant
     *
     * @return mixed
     */
    public function hasnotification($format = '')
    {
        return $this->getVar('hasnotification', $format);
    }

    /**
     * get module by dirname
     *
     * @param string $dirname directory name
     *
     * @return XoopsModule
     */
    public function getByDirname($dirname)
    {
        return \Xoops::getInstance()->getModuleByDirname($dirname);

    }
}

XOOPS / XoopsCore

Pull Request — master (#594)

XoopsModule::id() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
