Xmf\Module\Admin

Complexity

Total Complexity

37

Size/Duplication

Total Lines	436
Duplicated Lines	11.7 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	is26()	0	4	1
A	addConfigBoxLine()	0	4	1
A	addItemButton()	0	4	1
A	displayButton()	0	4	1
A	renderInfoBox()	0	4	1
A	displayInfoBox()	0	4	1
A	renderIndex()	0	4	1
A	displayIndex()	0	4	1
A	displayNavigation()	0	4	1
A	renderAbout()	0	4	1
A	setPaypal()	0	4	1
A	displayAbout()	0	4	1
A	getInstance()	0	23	3
A	menuIconPath()	0	10	2
A	addInfoBox()	0	6	1
A	addInfoBoxLine()	0	10	1
A	renderButton()	0	8	2
A	addConfigError()	17	17	2
A	addConfigAccept()	17	17	2
A	addConfigWarning()	17	17	2
B	iconUrl()	0	23	5
B	checkModuleVersion()	0	32	4

<?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;

/**
 * Xmf\Module\Admin provides helpful methods for module administration
 * uses.
 *
 * Xmf\Module\Admin also provides a method compatible subset of the
 * Xoops 2.6 ModuleAdmin class for use in transition from 2.5 to 2.6
 *
 * @category  Xmf\Module\Admin
 * @package   Xmf
 * @author    Richard Griffith <richard@geekwright.com>
 * @copyright 2011-2016 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @version   Release: 1.0
 * @link      http://xoops.org
 * @since     1.0
 */
class Admin
{

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

    /**
     * Constructor
     */
    private function __construct()
    {
        $this->version26 = self::is26();
    }

    /**
     * Retrieve a module admin instance
     *
     * If we are on 2.6 this will be the a XoopsModuleAdmin 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.
     *
     * **Always use this to get the ModuleAdmin instance if you use
     * anything (even the static methods) of this class.**
     *
     * @return object a ModuleAdmin instance.
     *
     * @since  1.0
     */
    public static function getInstance()
    {

        static $instance;

        if ($instance === null) {
            if (class_exists('\Xoops\Module\Admin', true)) {
                $instance  = new \Xoops\Module\Admin;
                self::$ModuleAdmin = $instance;
            } else {
                \Xmf\Loader::loadFile(
                    \XoopsBaseConfig::get('root-path') .
                    '/Frameworks/moduleclasses/moduleadmin/moduleadmin.php'
                );
                self::$ModuleAdmin = new \ModuleAdmin;
                $instance  = new \Xmf\Module\Admin;
            }

        }

        return $instance;

    }

    /**
     * Are we in a 2.6 environment?
     *
     * just to help with other admin things than ModuleAdmin
     *
     * not part of 2.6 module admin
     *
     * @return bool true if we are in a 2.6 environment
     */
    public static function is26()
    {
        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 2.6 module admin
     *
     * @param string $image icon name to prepend with path
     *
     * @return string true if we are in a 2.6 environment
     */
    public static function menuIconPath($image)
    {
        if (self::is26()) {
            return($image);
        } else {
            $path='../../Frameworks/moduleclasses/icons/32/';

            return($path.$image);
        }
    }

    /**
     * Add config line
     *
     * @param string $value message to include in config box
     * @param string $type  type of line to add
     *
     * @return bool
     */
    public function addConfigBoxLine($value = '', $type = 'default')
    {
        return self::$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 = '')

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

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

    {
        $this->lastInfoBoxTitle = $title;

        return self::$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 self::$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 self::$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 = " ")
    {
        if (null === $position) {
            $position = 'right';
        }

        return self::$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 = " ")
    {
        echo $this->renderButton($position, $delimiter);
    }

    /**
     * Render InfoBox
     *
     * @return string HTML rendered info box
     */
    public function renderInfoBox()
    {
        return self::$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 self::$ModuleAdmin->renderIndex();
    }

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

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

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

    /**
     * set paypal for 2.5 renderAbout
     *
     * @param string $paypal PayPal identifier for donate button
     *
     * @return void
     */
    public static function setPaypal($paypal = '')
    {
        self::$paypal = $paypal;
    }

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

    // not in regular ModuleAdmin

    /**
     * Add error to config box
     *
     * @param string $value the error message
     *
     * @return bool
     */
    public static function addConfigError($value = '')
    {
        if (self::is26()) {
            $type='error';
        } else {
            $path=\XoopsBaseConfig::get('url').'/Frameworks/moduleclasses/icons/16/';
            $line = "";
            $line .= "<span style='color : red; font-weight : bold;'>";
            $line .= "<img src='" . $path . "off.png' >";
            $line .= $value;
            $line .= "</span>";
            $value=$line;
            $type = 'default';
        }

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

    /**
     * Add accept (OK) message to config box
     *
     * @param string $value the OK message
     *
     * @return bool
     */
    public static function addConfigAccept($value = '')
    {
        if (self::is26()) {
            $type='accept';
        } else {
            $path=\XoopsBaseConfig::get('url').'/Frameworks/moduleclasses/icons/16/';
            $line = "";
            $line .= "<span style='color : green;'>";
            $line .= "<img src='" . $path . "on.png' >";
            $line .= $value;
            $line .= "</span>";
            $value=$line;
            $type = 'default';
        }

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

    /**
     * Add warning to config box
     *
     * @param string $value the warning message
     *
     * @return bool
     */
    public static function addConfigWarning($value = '')
    {
        if (self::is26()) {
            $type='warning';
        } else {
            $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 self::$ModuleAdmin->addConfigBoxLine($value, $type);
    }

    /**
     * Get an appropriate URL for system provided icons.
     *
     * Things which were in Frameworks in 2.5 are in media in 2.6,
     * making it harder to use and rely on the standard icons.
     *
     * not part of 2.6, just a transition assist
     *
     * @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;
            default:
            case '32':

case '32': $path = '32/'; break; does not seem to be reachable.

                $path='32/';
                break;
        }

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

        return(\XoopsBaseConfig::get('url') . $path . $name);
    }

    /**
     * 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 static function checkModuleVersion($moddir, $minversion)
    {
        \Xmf\Language::load('main', 'xmf');
        $return=false;
        $helper=\Xmf\Module\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_DEMOMVC_MODULE_VERSION,
                strtoupper($moddir),
                $min_version_f,
                $mod_version_f
            );
            if ($mod_modversion>=$minversion) {
                self::addConfigAccept($value);
                $return=true;
            } else {
                self::addConfigError($value);
            }
        } else {
            $value = sprintf(
                _AM_XMF_DEMOMVC_MODULE_NOTFOUND,
                strtoupper($moddir),
                $minversion/100
            );
            self::addConfigError($value);
        }

        return $return;
    }
}