config.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.
 */

use Xoops\Core\Kernel\Criteria;
use Xoops\Core\Kernel\CriteriaCompo;
use Xoops\Core\Kernel\CriteriaElement;
use Xoops\Core\Kernel\XoopsObjectHandler;

class UserconfigsConfigHandler extends XoopsObjectHandler
{
    private $_iHandler;

    private $_oHandler;

    private $_cachedConfigs = array();

    public function __construct()
    {
        $helper = Userconfigs::getInstance();
        $this->_iHandler = $helper->getHandlerItem();
        $this->_oHandler = $helper->getHandlerOption();
    }

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

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

    public function insertConfig(UserconfigsItem $config)
    {
        if (!$this->_iHandler->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_uid')])) {
            unset($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_uid')]);
        }
        return true;
    }

    public function deleteConfig(UserconfigsItem $config)
    {
        if (!$this->_iHandler->delete($config, true)) {
            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], true);
            }
        }
        if (!empty($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_uid')])) {
            unset($this->_cachedConfigs[$config->getVar('conf_modid')][$config->getVar('conf_uid')]);
        }
        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->_iHandler->getObjects($criteria2, $id_as_key);
    }

    public function getConfigCount(CriteriaElement $criteria = null)
    {
        return $this->_iHandler->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 deleteConfigsByModule($module = 0)
    {
        $criteria = new Criteria('conf_modid', intval($module));
        $configs = $this->getConfigs($criteria, true);
        if (is_array($configs)) {
            foreach (array_keys($configs) as $i) {
                $this->deleteConfig($configs[$i]);
            }
            return true;
        }
        return false;
    }

    public function getConfigsByUser($uid, $moduleId)
    {
        static $_cachedConfigs;
        if (!empty($_cachedConfigs[$moduleId][$uid])) {
            return $_cachedConfigs[$moduleId][$uid];
        } else {
            $ret = array();
            $criteria = new CriteriaCompo(new Criteria('conf_modid', intval($moduleId)));
            $criteria->add(new Criteria('conf_uid', intval($uid)));
            $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[$moduleId][$uid] = $ret;
            return $_cachedConfigs[$moduleId][$uid];
        }
    }

    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_uid = 0)
    {
        if (!empty($this->_cachedConfigs[$conf_modid][$conf_uid])) {
            return $this->_cachedConfigs[$conf_modid][$conf_uid];
        } else {
            $criteria = new CriteriaCompo(new Criteria('conf_modid', $conf_modid));
            if (empty($conf_uid)) {
                $criteria->add(new Criteria('conf_uid', $conf_uid));
            }
            $criteria->setSort('conf_order');
            $criteria->setOrder('ASC');
            $configs = $this->_iHandler->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_uid] = $ret;
            return $ret;
        }
    }

    public function createDefaultUserConfigs($uid, XoopsModule $module)
    {
        /* @var $plugin UserconfigsPluginInterface */
        if ($plugin = \Xoops\Module\Plugin::getPlugin($module->getVar('dirname'), 'userconfigs')) {
            // now reinsert them with the new settings
            $configs = $plugin->configs();
            if (!is_array($configs)) {
                $configs = array();
            }

            if (is_array($configs) && count($configs) > 0) {
                $order = 0;
                foreach ($configs as $config) {
                    $confobj = $this->createConfig();
                    $confobj->setVar('conf_modid', $module->getVar('mid'));
                    $confobj->setVar('conf_uid', $uid);
                    $confobj->setVar('conf_name', $config['name']);
                    $confobj->setVar('conf_title', $config['title'], true);
                    $confobj->setVar('conf_desc', $config['description'], true);
                    $confobj->setVar('conf_formtype', $config['formtype']);
                    $confobj->setVar('conf_valuetype', $config['valuetype']);
                    $confobj->setConfValueForInput($config['default'], true);
                    $confobj->setVar('conf_order', $order);
                    if (isset($config['options']) && is_array($config['options'])) {
                        foreach ($config['options'] as $key => $value) {
                            $confop = $this->createConfigOption();
                            $confop->setVar('confop_name', $key, true);
                            $confop->setVar('confop_value', $value, true);
                            $confobj->setConfOptions($confop);
                            unset($confop);
                        }
                    }
                    ++$order;
                    $this->insertConfig($confobj);
                    unset($confobj);
                }
                unset($configs);
            }
        }
    }
}