AbstractHelper.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;

use Xmf\Module\Helper;

abstract class AbstractHelper
{
    protected $module;

    protected $debug;

    public function __construct($module = null)
    {
        $this->module = null;

        if (empty($module)) {
            // nothing specified, use current module
            // check if we are running in 2.6
            if (class_exists('Xoops', false)) {
                $xoops=\Xoops::getInstance();
                if ($xoops->isModule()) {
                    $this->module = $xoops->module;
                }
            } else {
                $this->module = $GLOBALS['xoopsModule'];
            }
        } elseif (is_scalar($module)) {
            // dirname specified, get a module object
            $helper = Helper::getHelper($module);
            if ($helper) {
                $this->module = $helper->getModule();
            }
        } else {
            // assume a passed object is appropriate
            if (is_object($module)) {
                $this->module = $module;
            }
        }
        if (is_object($this->module)) {
            $this->init();
        }
    }

    abstract public function init();

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

    public function addLog($log)
    {
        if ($this->debug) {
            \Xoops::getInstance()->logger()->debug($log, array('channel'=>'Extra'));
        }
    }
}