config.php

Go to the documentation of this file.

<?php
use Xoops\Core\Kernel\Criteria;
use Xoops\Core\Kernel\CriteriaCompo;
use Xoops\Core\Kernel\CriteriaElement;
use Xoops\Core\Kernel\XoopsObjectHandler;

class XoopsConfigHandler extends XoopsObjectHandler
{
    private $_cHandler;

    private $_oHandler;

    private $_cachedConfigs = array();

    public function __construct()
    {
        $this->_cHandler = Xoops::getInstance()->getHandlerConfigitem();
        $this->_oHandler = Xoops::getInstance()->getHandlerConfigoption();
    }

    public function createConfig()
    {
        $instance = $this->_cHandler->create();
        return $instance;
    }

    public function getConfig($id, $withoptions = false)
    {
        /* @var $config XoopsConfigItem */
        $config = $this->_cHandler->get($id);
        if ($withoptions == true) {
            $config->setConfOptions($this->getConfigOptions(new Criteria('conf_id', $id)));
        }
        return $config;
    }

    public function insertConfig(XoopsConfigItem $config)
    {
        if (!$this->_cHandler->insert($config)) {
            return false;
        }
        $options = $config->getConfOptions();
        $count = count($options);
        $conf_id = $config->getVar('conf_id');
        for ($i = 0; $i < $count; ++$i) {
            $options[$i]->setVar('conf_id', $conf_id);
            if (!$this->_oHandler->insert($options[$i])) {
                foreach ($options[$i]->getErrors() as $msg) {
                    $config->setErrors($msg);
                }
            }
        }
        if (!empty($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_catid')])) {
            unset($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_catid')]);
        }
        return true;
    }

    public function deleteConfig(XoopsConfigItem $config)
    {
        if (!$this->_cHandler->delete($config)) {
            return false;
        }
        $options = $config->getConfOptions();
        $count = count($options);
        if ($count == 0) {
            $options = $this->getConfigOptions(new Criteria('conf_id', $config->getVar('conf_id')));
            $count = count($options);
        }
        if (is_array($options) && $count > 0) {
            for ($i = 0; $i < $count; ++$i) {
                $this->_oHandler->delete($options[$i]);
            }
        }
        if (!empty($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_catid')])) {
            unset($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_catid')]);
        }
        return true;
    }

    public function getConfigs(CriteriaElement $criteria = null, $id_as_key = false)
    {
        $criteria2 = new CriteriaCompo();
        if ($criteria) {
            $criteria2->add($criteria);
            if (!$criteria->getSort()) {
                $criteria2->setSort('conf_order');
                $criteria2->setOrder('ASC');
            }
        } else {
            $criteria2->setSort('conf_order');
            $criteria2->setOrder('ASC');
        }
        return $this->_cHandler->getObjects($criteria2, $id_as_key);
    }

    public function getConfigCount(CriteriaElement $criteria = null)
    {
        return $this->_cHandler->getCount($criteria);
    }

    public function getConfigsByModule($module = 0)
    {
        $ret = array();
        $criteria = new Criteria('conf_modid', intval($module));
        $configs = $this->getConfigs($criteria, true);
        if (is_array($configs)) {
            foreach (array_keys($configs) as $i) {
                $ret[$configs[$i]->getVar('conf_name')] = $configs[$i]->getConfValueForOutput();
            }
        }
        $_cachedConfigs[$module] = $ret;
        return $_cachedConfigs[$module];
    }

    public function getConfigsByCat($category, $module = 0)
    {
        static $_cachedConfigs;
        if (!empty($_cachedConfigs[$module][$category])) {
            return $_cachedConfigs[$module][$category];
        } else {
            $ret = array();
            $criteria = new CriteriaCompo(new Criteria('conf_modid', intval($module)));
            if (!empty($category)) {
                $criteria->add(new Criteria('conf_catid', intval($category)));
            }
            $configs = $this->getConfigs($criteria, true);
            if (is_array($configs)) {
                foreach (array_keys($configs) as $i) {
                    $ret[$configs[$i]->getVar('conf_name')] = $configs[$i]->getConfValueForOutput();
                }
            }
            $_cachedConfigs[$module][$category] = $ret;
            return $_cachedConfigs[$module][$category];
        }
    }

    public function createConfigOption()
    {
        $inst = $this->_oHandler->create();
        return $inst;
    }

    public function getConfigOption($id)
    {
        $inst = $this->_oHandler->get($id);
        return $inst;
    }

    public function getConfigOptions(CriteriaElement $criteria = null, $id_as_key = false)
    {
        return $this->_oHandler->getObjects($criteria, $id_as_key);
    }

    public function getConfigOptionsCount(CriteriaElement $criteria = null)
    {
        return $this->_oHandler->getCount($criteria);
    }

    public function getConfigList($conf_modid, $conf_catid = 0)
    {
        if (!empty($this->_cachedConfigs[$conf_modid][$conf_catid])) {
            return $this->_cachedConfigs[$conf_modid][$conf_catid];
        } else {
            $criteria = new CriteriaCompo(new Criteria('conf_modid', $conf_modid));
            if (empty($conf_catid)) {
                $criteria->add(new Criteria('conf_catid', $conf_catid));
            }
            $criteria->setSort('conf_order');
            $criteria->setOrder('ASC');
            $configs = $this->_cHandler->getObjects($criteria);
            $confcount = count($configs);
            $ret = array();
            for ($i = 0; $i < $confcount; ++$i) {
                $ret[$configs[$i]->getVar('conf_name')] = $configs[$i]->getConfValueForOutput();
            }
            $this->_cachedConfigs[$conf_modid][$conf_catid] = $ret;
            return $ret;
        }
    }
}