class.ilBlockSetting.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2008 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | 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.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/


class ilBlockSetting
{
    public static $setting = array();
    public static $pd_preloaded = false;

    public static function _lookup($a_type, $a_setting, $a_user = 0, $a_block_id = 0)
    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        
        $key = $a_type . ":" . $a_setting . ":" . $a_user . ":" . $a_block_id;
        if (isset(self::$setting[$key])) {
            return self::$setting[$key];
        }
        
        $set = $ilDB->query(sprintf(
            "SELECT value FROM il_block_setting WHERE type = %s " .
            "AND user_id = %s AND setting = %s AND block_id = %s",
            $ilDB->quote($a_type, "text"),
            $ilDB->quote($a_user, "integer"),
            $ilDB->quote($a_setting, "text"),
            $ilDB->quote($a_block_id, "integer")
        ));
        if ($rec = $ilDB->fetchAssoc($set)) {
            self::$setting[$key] = $rec["value"];
            return $rec["value"];
        } elseif ($ilSetting->get('block_default_setting_' . $a_type . '_' . $a_setting, false)) {
            self::$setting[$key] = $ilSetting->get('block_default_setting_' . $a_type . '_' . $a_setting, false);
            return $ilSetting->get('block_default_setting_' . $a_type . '_' . $a_setting, false);
        } else {
            self::$setting[$key] = false;
            return false;
        }
    }
    
    public static function _setDefaultSetting($a_type, $a_setting, $a_value)
    {
        global $DIC;

        $ilSetting = $DIC->settings();
        $ilSetting->set('block_default_setting_' . $a_type . '_' . $a_setting, $a_value);
    }

    public static function _unsetDefaultSetting($a_type, $a_setting)
    {
        global $DIC;

        $ilSetting = $DIC->settings();
        $ilSetting->delete('block_default_setting_' . $a_type . '_' . $a_setting);
    }
    
    public static function preloadPDBlockSettings()
    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilUser = $DIC->user();

        if (!self::$pd_preloaded) {
            $blocks = array("pdbookm", "pdcal", "pdfeedb", "pditems",
                "pdmail", "pdnews", "pdnotes", "pdsysmess", "pdtag");
            $settings = array("detail", "nr", "side");
            $user_id = $ilUser->getId();

            foreach ($blocks as $b) {
                foreach ($settings as $s) {
                    $key = $b . ":" . $s . ":" . $user_id . ":0";
                    if ($s == "detail") {
                        self::$setting[$key] = 2;
                    } else {
                        self::$setting[$key] = false;
                    }
                }
            }

            $set = $ilDB->query(
                $q = "SELECT type, setting, value FROM il_block_setting WHERE " .
                " user_id = " . $ilDB->quote($user_id, "integer") .
                " AND " . $ilDB->in("type", $blocks, false, "text") .
                " AND " . $ilDB->in("setting", $settings, false, "text")
            );
            while ($rec = $ilDB->fetchAssoc($set)) {
                $key = $rec["type"] . ":" . $rec["setting"] . ":" . $user_id . ":0";
                self::$setting[$key] = $rec["value"];
            }

            self::$pd_preloaded = true;
        }
    }

    public static function _write($a_type, $a_setting, $a_value, $a_user = 0, $a_block_id = 0)
    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $ilDB->manipulate(sprintf(
            "DELETE FROM il_block_setting WHERE type = %s AND user_id = %s AND block_id = %s AND setting = %s",
            $ilDB->quote($a_type, "text"),
            $ilDB->quote($a_user, "integer"),
            $ilDB->quote((int) $a_block_id, "integer"),
            $ilDB->quote($a_setting, "text")
        ));
        $ilDB->manipulate(sprintf(
            "INSERT INTO il_block_setting  (type, user_id, setting, block_id, value) VALUES (%s,%s,%s,%s,%s)",
            $ilDB->quote($a_type, "text"),
            $ilDB->quote($a_user, "integer"),
            $ilDB->quote($a_setting, "text"),
            $ilDB->quote((int) $a_block_id, "integer"),
            $ilDB->quote($a_value, "text")
        ));
    }

    public static function _lookupDetailLevel($a_type, $a_user = 0, $a_block_id = 0)
    {
        $detail = ilBlockSetting::_lookup($a_type, "detail", $a_user, $a_block_id);

        if ($detail === false) {                // return a level of 2 (standard value)
            // if record does not exist
            return 2;
        } else {
            return $detail;
        }
    }

    public static function _writeDetailLevel($a_type, $a_value, $a_user = 0, $a_block_id = 0)
    {
        ilBlockSetting::_write($a_type, "detail", $a_value, $a_user, $a_block_id);
    }

    public static function _lookupNr($a_type, $a_user = 0, $a_block_id = 0)
    {
        $nr = ilBlockSetting::_lookup($a_type, "nr", $a_user, $a_block_id);

        return $nr;
    }

    public static function _writeNumber($a_type, $a_value, $a_user = 0, $a_block_id = 0)
    {
        ilBlockSetting::_write($a_type, "nr", $a_value, $a_user, $a_block_id);
    }

    public static function _lookupSide($a_type, $a_user = 0, $a_block_id = 0)
    {
        $side = ilBlockSetting::_lookup($a_type, "side", $a_user, $a_block_id);

        return $side;
    }

    public static function _writeSide($a_type, $a_value, $a_user = 0, $a_block_id = 0)
    {
        ilBlockSetting::_write($a_type, "side", $a_value, $a_user, $a_block_id);
    }

    public static function _deleteSettingsOfUser($a_user)
    {
        global $DIC;

        $ilDB = $DIC->database();
        
        if ($a_user > 0) {
            $ilDB->manipulate("DELETE FROM il_block_setting WHERE user_id = " .
                $ilDB->quote($a_user, "integer"));
        }
    }

    public static function _deleteSettingsOfBlock($a_block_id, $a_block_type)
    {
        global $DIC;

        $ilDB = $DIC->database();
        
        if ($a_block_id > 0) {
            $ilDB->manipulate("DELETE FROM il_block_setting WHERE block_id = " .
                $ilDB->quote($a_block_id, "integer") .
                " AND type = " . $ilDB->quote($a_block_type, "text"));
        }
    }

    public static function cloneSettingsOfBlock(string $block_type, int $block_id, int $new_block_id)
    {
        global $DIC;

        $db = $DIC->database();

        $set = $db->queryF(
            "SELECT * FROM il_block_setting " .
            " WHERE block_id = %s AND type = %s AND user_id = %s",
            array("integer", "text", "integer"),
            array($block_id, $block_type, 0)
        );
        while ($rec = $db->fetchAssoc($set)) {
            self::_write($block_type, $rec["setting"], $rec["value"], 0, $new_block_id);
        }
    }
}