GenericHelper.php

Go to the documentation of this file.

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

class GenericHelper
{
    protected $dirname;

    protected $object;

    private $_handlers;

    protected $configs;

    protected $debug;

    private function __construct($dirname)
    {
        $this->dirname = $dirname;
    }

    public static function getInstance($dirname = 'notsetyet')
    {
        static $instance = array();
        if (!isset($instance[$dirname])) {
            $class = __CLASS__;
            $instance[$dirname] = new $class($dirname);
        }

        return $instance[$dirname];

    }

    public function getModule()
    {
        if ($this->object == null) {
            $this->_initObject();
        }
        if (!is_object($this->object)) {
            $this->addLog("ERROR :: Module '{$this->dirname}' does not exist");
        }

        return $this->object;
    }

    public function getConfig($name)
    {
        if ($this->configs == null) {
            $this->_initConfig();
        }
        if (!$name) {
            $this->addLog("Getting all config");

            return $this->configs;
        }

        if (!isset($this->configs[$name])) {
            $this->addLog("ERROR :: Config '{$name}' does not exist");
            $ret = null;

            return $ret;
        }

        $this->addLog("Getting config '{$name}' : " . $this->configs[$name]);

        return $this->configs[$name];
    }

    public function getHandler($name)
    {
        $ret = false;
        $name = strtolower($name);
        if (!isset($this->_handlers[$name])) {
            $this->_initHandler($name);
        }

        if (!isset($this->_handlers[$name])) {
            $this->addLog("ERROR :: Handler '{$name}' does not exist");
        } else {
            $this->addLog("Getting handler '{$name}'");
            $ret = $this->_handlers[$name];
        }

        return $ret;
    }

    private function _initObject()
    {
        global $xoopsModule;
        if (isset($xoopsModule) && is_object($xoopsModule)
            && $xoopsModule->getVar('dirname') == $this->dirname
        ) {
            $this->object = $xoopsModule;
        } else {
            /* @var $module_handler XoopsModuleHandler */
            $module_handler = xoops_getHandler('module');
            $this->object = $module_handler->getByDirname($this->dirname);
        }
        $this->addLog('INIT MODULE OBJECT');
    }

    private function _initConfig()
    {
        $this->addLog('INIT CONFIG');
        global $xoopsModule;
        if (isset($xoopsModule) && is_object($xoopsModule)
            && $xoopsModule->getVar('dirname') == $this->dirname
        ) {
            global $xoopsModuleConfig;
            $this->configs =& $xoopsModuleConfig;
        } else {
            /* @var $config_handler XoopsConfigHandler */
            $config_handler = xoops_gethandler('config');
            $this->configs = $config_handler->getConfigsByCat(
                0, $this->getModule()->getVar('mid')
            );
        }
    }

    private function _initHandler($name)
    {
        $this->addLog('INIT ' . $name . ' HANDLER');

        if (!isset($this->_handlers[$name])) {
            $hnd_file = \XoopsBaseConfig::get('root-path') .
                "/modules/{$this->dirname}/class/{$name}.php";
            if (file_exists($hnd_file)) {
                include_once $hnd_file;
            }
            $class = ucfirst(strtolower($this->dirname))
                . ucfirst(strtolower($name)) . 'Handler';
            if (class_exists($class)) {
                $db = \XoopsDatabaseFactory::getConnection();
                $this->_handlers[$name] = new $class($db);
                $this->addLog("Loading class '{$class}'");
            } else {
                $this->addLog("ERROR :: Class '{$class}' could not be loaded");
            }
        }
    }

    public function loadLanguage($name)
    {
        if ($ret = \Xmf\Language::load($name, $this->dirname)) {
            $this->addLog("Loading language '{$name}'");
        } else {
            $this->addLog("ERROR :: Language '{$name}' could not be loaded");
        }

        return $ret;
    }

    public function setDebug($bool = true)
    {
        $this->debug = (bool) $bool;
    }

    public function addLog($log)
    {
        if ($this->debug) {
            if (!is_scalar($log)) {
                $log = serialize($log);
            }
            $name = is_object($this->object) ? $this->object->name() : $this->dirname;
            \Xoops::getInstance()->logger()->debug($log, array('channel'=>'Extra', 'name'=>$name));
        }
    }

    // these added to mimic 2.6 Xoops\Module\Helper\HelperAbstract

    public function isCurrentModule()
    {
        if ($GLOBALS['xoopsModule']->getVar('dirname') == $this->dirname) {
            return true;
        }

        return false;
    }

    public function isUserAdmin()
    {
        return $GLOBALS['xoopsUser']->isAdmin($this->getModule()->getVar('mid'));
    }

    public function url($url = '')
    {
        return \XoopsBaseConfig::get('url') . '/modules/' . $this->dirname . '/' . $url;
    }

    public function path($path = '')
    {
        return \XoopsBaseConfig::get('root-path') . '/modules/' . $this->dirname . '/' . $path;
    }

    public function redirect($url, $time = 3, $message = '')
    {
        redirect_header($this->url($url), $time, $message);
        exit;
    }

}