HelperAbstract.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 Xoops\Module\Helper;

abstract class HelperAbstract
{
    protected $_dirname = '';

    protected $_module = null;

    protected $_debug = false;

    public function init()
    {
    }

    protected function setDirname($dirname)
    {
        $this->_dirname = strtolower($dirname);
    }

    protected function setDebug($debug)
    {
        $this->_debug = (bool)$debug;
    }

    static function getInstance()
    {
        static $instance = false;
        $id = $className = get_called_class();
        if ($className == 'Xoops\Module\Helper\Dummy') {
            $id = @\Xoops::getInstance()->registry()->get('module_helper_id');
        }
        if (!isset($instance[$id])) {
            /* @var $class Xoops\Module\Helper\HelperAbstract */
            $class = new $className();
            $class->init();
            $instance[$id] = $class;
        }
        return $instance[$id];
    }

    public function getModule()
    {
        if ($this->_module == null) {
            $this->_initModule();
        }
        return $this->_module;
    }

    public function xoops()
    {
        return \Xoops::getInstance();
    }

    public function getConfig($name)
    {
        $name = strtolower($name);
        $result = $this->xoops()->getModuleConfig($name, $this->_dirname);
        $this->_addLog("Getting config '{$name}' : " . $result);
        return $result;
    }

    public function getConfigs()
    {
        $result = $this->xoops()->getModuleConfigs($this->_dirname);
        $this->_addLog("Getting configs for {$this->_dirname} module");
        return $result;
    }

    public function getHandler($name)
    {
        $name = strtolower($name);
        $this->_addLog("Getting handler '{$name}'");
        return $this->xoops()->getModuleHandler($name, $this->_dirname);
    }

    public function disableCache()
    {
        $this->xoops()->appendConfig('module_cache', array($this->getModule()->getVar('mid') => 0), true, $this->_dirname);
        $this->_addLog("Disabling module cache");
    }

    public function isCurrentModule()
    {
        if ($this->xoops()->moduleDirname == $this->_dirname) {
            return true;
        }
        return false;
    }

    public function isUserAdmin()
    {
        if ($this->xoops()->isUser()) {
            return $this->xoops()->user->isAdmin($this->getModule()->getVar('mid'));
        }
        return false;
    }

    public function url($url = '')
    {
        return $this->xoops()->url('modules/' . $this->_dirname . '/' . $url);
    }

    public function path($path = '')
    {
        return $this->xoops()->path('modules/' . $this->_dirname . '/' . $path);
    }

    public function redirect($url, $time = 3, $message = '', $addredirect = true, $allowExternalLink = false)
    {
        $this->xoops()->redirect($this->url($url), $time, $message, $addredirect, $allowExternalLink);
    }

    public function loadLanguage($language)
    {
        $this->xoops()->loadLanguage($language, $this->_dirname);
        $this->_addLog("Loading language '{$language}'");
    }

    public function loadLocale()
    {
        $this->xoops()->loadLocale($this->_dirname);
        $this->_addLog("Loading locale");
    }

    public function getForm($obj, $name)
    {
        $name = strtolower($name);
        $this->_addLog("Loading form '{$name}'");
        return $this->xoops()->getModuleForm($obj, $name, $this->_dirname);
    }

    private function _initModule()
    {
        if ($this->isCurrentModule()) {
            $this->_module = $this->xoops()->module;
        } else {
            $this->_module = $this->xoops()->getModuleByDirname($this->_dirname);
        }
        if (!$this->_module instanceof \XoopsModule) {
            $this->_module = $this->xoops()->getHandlerModule()->create();
        }
        $this->_addLog('Loading module');
    }

    protected function _addLog($log)
    {
        if ($this->_debug) {
            $this->xoops()->preload()->triggerEvent('core.module.addlog', array(
                $this->getModule()->getVar('name'),
                $log
            ));
        }
    }
}