Admin::isXng() - Code Metrics - Inspection of "Merge pull request #1037 from geekwright/xmf-1-2-2..." - geekwright/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 14ea10...f698cc )

by Richard
created 2021-05-08 19:32 UTC
Admin::isXng() A

↳ Parent: Admin
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
<?php
/*
 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.
 */

namespace Xmf\Module;

use Xmf\Language;

/**
 * Xmf\Module\Admin provides helpful methods for module administration
 * uses.
 *
 * Xmf\Module\Admin provides a method compatible subset of the Xoops\Module\Admin class
 * (introduced in 2.6) and other convenience methods useful in transition
 *
 * @category  Xmf\Module\Admin
 * @package   Xmf
 * @author    Richard Griffith <[email protected]>
 * @copyright 2011-2021 XOOPS Project (https://xoops.org)
 * @license   GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 */
class Admin
{

    /**
     * The real ModuleAdmin object
     *
     * @var object
     */
    protected static $ModuleAdmin = null;
    protected $lastInfoBoxTitle = null;
    protected static $paypal = '';

    /**
     * Constructor
     */
    protected function __construct()
    {
    }

    /**
     * Retrieve a module admin instance
     *
     * If we are on a next generation system this will be the a native Xoops\Module\Admin instance.
     * Older systems with the Frameworks based admin class will get an instance of this class which
     * provides compatible methods built from the old Frameworks version.
     *
     * @return object a ModuleAdmin or Xoops\Module\Admin instance.
     */
    public static function getInstance()
    {

        static $instance;

        if ($instance === null) {
            if (class_exists('\Xoops\Module\Admin', true)) {
                $instance = new \Xoops\Module\Admin;
filter:
    dependency_paths: ["lib/*"]
                static::$ModuleAdmin = $instance;
            } else {
                include_once $GLOBALS['xoops']->path('Frameworks/moduleclasses/moduleadmin/moduleadmin.php');
                static::$ModuleAdmin = new \ModuleAdmin;
                Language::load('xmf');
                $instance = new static();
            }
        }

        return $instance;
    }

    /**
     * Add config line
     *
     * @param string $value message to include in config box
     * @param string $type  type of line to add
     *                       minimal set of acceptable types and value expectation
     *                       'default' - value is message displayed directly (also used for unknown types)
     *                       'folder'  - value is directory name, will display accept if exists, error if not
     *                       'chmod'   - value is array(directory, permission) accept if exists with permission,
     *                                   else error
     *                       'module'  - value is string module name, or array(module name, errortype)
     *                                   If module is active, an accept line displays, otherwise, a warning
     *                                   (if value is array(module, "warning") or an error displays.
     *
     * @return bool
     */
    public function addConfigBoxLine($value = '', $type = 'default')
    {
        if ($type === 'module') {
            $mod = (is_array($value)) ? $value[0] : $value;

            if (xoops_isActiveModule($mod)) {
                return $this->addConfigAccept(sprintf(_AM_XMF_MODULE_INSTALLED, $mod));
            } else {
                $nomod = (is_array($value)) ? $value[1] : 'error';

                $line = sprintf(_AM_XMF_MODULE_NOT_INSTALLED, $mod);
                if ($nomod === 'warning') {
                    return $this->addConfigWarning($line);
                } else {
                    return $this->addConfigError($line);
                }
            }
        }
        return static::$ModuleAdmin->addConfigBoxLine($value, $type);
    }

    /**
     * Add Info box
     *
     * @param string $title info box title
     * @param string $type  for compatibility only
     * @param string $extra for compatibility only
     *
     * @return bool
     */
    public function addInfoBox($title, $type = 'default', $extra = '')
    public function addInfoBox($title, /** @scrutinizer ignore-unused */ $type = 'default', $extra = '')
    {
        $this->lastInfoBoxTitle = $title;

        return static::$ModuleAdmin->addInfoBox($title);
    }

    /**
     * Add line to the info box
     *
     * @param string $text  text to add to info box
     * @param string $type  type of infobox line
     * @param string $color color for infobox line
     *
     * @return bool
     */
    public function addInfoBoxLine($text = '', $type = 'default', $color = 'inherit')
    {
        return static::$ModuleAdmin->addInfoBoxLine(
            $this->lastInfoBoxTitle,
            $text,
            '',
            $color,
            $type
        );
    }

    /**
     * Add Item button
     *
     * @param string $title title of button
     * @param string $link  link for button
     * @param string $icon  icon for button
     * @param string $extra extra
     *
     * @return bool
     */
    public function addItemButton($title, $link, $icon = 'add', $extra = '')
    {
        return static::$ModuleAdmin->addItemButton($title, $link, $icon, $extra);
    }

    /**
     * Render all items buttons
     *
     * @param string $position  button position (left, right)
     * @param string $delimiter delimiter between buttons
     *
     * @return string
     */
    public function renderButton($position = null, $delimiter = "&nbsp;")
    {
        if (null === $position) {
            $position = 'right';
        }

        return static::$ModuleAdmin->renderButton($position, $delimiter);
    }

    /**
     * Display all item buttons
     *
     * @param string $position  button position (left, right)
     * @param string $delimiter delimiter between buttons
     *
     * @return void
     */
    public function displayButton($position = null, $delimiter = "&nbsp;")
    {
        echo $this->renderButton($position, $delimiter);
    }

    /**
     * Render InfoBox
     *
     * @return string HTML rendered info box
     */
    public function renderInfoBox()
    {
        return static::$ModuleAdmin->renderInfoBox();
    }

    /**
     * Display InfoBox
     *
     * @return void
     */
    public function displayInfoBox()
    {
        echo $this->renderInfoBox();
    }

    /**
     * Render index page for admin
     *
     * @return string HTML rendered info box
     */
    public function renderIndex()
    {
        return static::$ModuleAdmin->renderIndex();
    }

    /**
     * Display index page for admin
     *
     * @return void
     */
    public function displayIndex()
    {
        echo $this->renderIndex();
    }

    /**
     * Render the navigation menu
     *
     * @param string $menu menu key (script name, i.e. index.php)
     *
     * @return string
     */
    public function renderNavigation($menu = '')
    {
        return static::$ModuleAdmin->addNavigation($menu);
    }

    /**
     * Display the navigation menu
     *
     * @param string $menu menu key (script name, i.e. index.php)
     *
     * @return void
     */
    public function displayNavigation($menu = '')
    {
        echo static::$ModuleAdmin->addNavigation($menu);
    }

    /**
     * Render about page
     *
     * @param bool $logo_xoops display XOOPS logo
     *
     * @return bool|mixed|string
     */
    public function renderAbout($logo_xoops = true)
    {
        return static::$ModuleAdmin->renderAbout(static::$paypal, $logo_xoops);
    }

    /**
     * Display about page
     *
     * @param bool $logo_xoops display XOOPS logo
     *
     * @return void
     */
    public function displayAbout($logo_xoops = true)
    {
        echo $this->renderAbout($logo_xoops);
    }

    /**
     * Add error to config box
     *
     * @param string $value the error message
     *
     * @return bool
     */
    public function addConfigError($value = '')
    {
        $path = XOOPS_URL . '/Frameworks/moduleclasses/icons/16/';
        $line = "";
        $line .= "<span style='color : red; font-weight : bold;'>";
        $line .= "<img src='" . $path . "0.png' >";
        $line .= $value;
        $line .= "</span>";
        $value = $line;
        $type = 'default';

        return static::$ModuleAdmin->addConfigBoxLine($value, $type);
    }

    /**
     * Add accept (OK) message to config box
     *
     * @param string $value the OK message
     *
     * @return bool
     */
    public function addConfigAccept($value = '')
    {
        $path = XOOPS_URL . '/Frameworks/moduleclasses/icons/16/';
        $line = "";
        $line .= "<span style='color : green;'>";
        $line .= "<img src='" . $path . "1.png' >";
        $line .= $value;
        $line .= "</span>";
        $value = $line;
        $type = 'default';

        return static::$ModuleAdmin->addConfigBoxLine($value, $type);
    }

    /**
     * Add warning to config box
     *
     * @param string $value the warning message
     *
     * @return bool
     */
    public function addConfigWarning($value = '')
    {
        $path = XOOPS_URL . '/Frameworks/moduleclasses/icons/16/';
        $line = "";
        $line .= "<span style='color : orange; font-weight : bold;'>";
        $line .= "<img src='" . $path . "warning.png' >";
        $line .= $value;
        $line .= "</span>";
        $value = $line;
        $type = 'default';

        return static::$ModuleAdmin->addConfigBoxLine($value, $type);
    }


    /**
     * Check for installed module and version and do addConfigBoxLine()
     *
     * @param string  $moddir     - module directory name
     * @param integer $minversion - minimum acceptable module version (100 = V1.00)
     *
     * @return bool true if requested version of the module is available
     */
    public function addConfigModuleVersion($moddir, $minversion)
    {
        $return = false;
        $helper = Helper::getHelper($moddir);
        if (is_object($helper) && is_object($helper->getModule())) {
            $mod_modversion = $helper->getModule()->getVar('version');
            $mod_version_f = $mod_modversion / 100;
            $min_version_f = $minversion / 100;
            $value = sprintf(
                _AM_XMF_MODULE_VERSION,
                strtoupper($moddir),
                $min_version_f,
                $mod_version_f
            );
            if ($mod_modversion >= $minversion) {
                $this->addConfigAccept($value);
                $return = true;
            } else {
                $this->addConfigError($value);
            }
        } else {
            $value = sprintf(
                _AM_XMF_MODULE_NOTFOUND,
                strtoupper($moddir),
                $minversion / 100
            );
            $this->addConfigError($value);
        }

        return $return;
    }

    // the following not part of next generation Xoops\Module\Admin

    /**
     * Are we in a next generation environment?
     *
     * not part of next generation Xoops\Module\Admin
     *
     * @return bool true if we are in a post XOOPS 2.5.x environment
     */
    protected static function isXng()
    {
        return class_exists('\Xoops', false);
    }

    /**
     * Get an appropriate imagePath for menu.php use.
     *
     * just to help with other admin things than ModuleAdmin
     *
     * not part of next generation Xoops\Module\Admin
     *
     * @param string $image icon name to prepend with path
     *
     * @return string the icon path
     */
    public static function menuIconPath($image)
    {
        if (static::isXng()) {
            return($image);
        } else {
            $path = '../../Frameworks/moduleclasses/icons/32/';

            return($path . $image);
        }
    }

    /**
     * Get an appropriate URL for system provided icons.
     *
     * Things which were in Frameworks in 2.5 are in media in later versions,
     * making it harder to use and rely on the standard icons.
     *
     * not part of next generation Xoops\Module\Admin
     *
     * @param string $name the image name to provide URL for, or blank
     *                     to just get the URL path.
     * @param string $size the icon size (directory). Valid values are
     *                     16, 32 or /. A '/' slash will simply set the
     *                     path to the icon directory and append $image.
     *
     * @return string path to icons
     */
    public static function iconUrl($name = '', $size = '32')
    {
        switch ($size) {
            case '16':
                $path = '16/';
                break;
            case '/':
                $path = '';
                break;
            case '32':
            default:
                $path = '32/';
                break;
        }

        if (static::isXng()) {
            $path = '/media/xoops/images/icons/' . $path;
        } else {
            $path = '/Frameworks/moduleclasses/icons/' . $path;
        }

        return(XOOPS_URL . $path . $name);
    }

    /**
     * set paypal for 2.5.x renderAbout
     *
     * not part of next generation Xoops\Module\Admin
     *
     * @param string $paypal PayPal identifier for donate button
     *
     * @return void
     */
    public static function setPaypal($paypal = '')
    {
        static::$paypal = $paypal;
    }
}

geekwright / XoopsCore25

Push — master ( 14ea10...f698cc )

Admin::isXng() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
