Block Setting class. More...

Collaboration diagram for ilBlockSetting:

Static Public Member Functions
static	_lookup ($a_type, $a_setting, $a_user=0, $a_block_id=0)
	Lookup setting from database. More...

static	_setDefaultSetting ($a_type, $a_setting, $a_value)
	Sets a default setting for a block. More...

static	_unsetDefaultSetting ($a_type, $a_setting)
	Unsets a default setting for a block. More...

static	preloadPDBlockSettings ()
	Preload pd info. More...

static	_write ($a_type, $a_setting, $a_value, $a_user=0, $a_block_id=0)
	Write setting to database. More...

static	_lookupDetailLevel ($a_type, $a_user=0, $a_block_id=0)
	Lookup detail level. More...

static	_writeDetailLevel ($a_type, $a_value, $a_user=0, $a_block_id=0)
	Write detail level to database. More...

static	_writeNumber ($a_type, $a_value, $a_user=0, $a_block_id=0)
	Write number to database. More...

static	_lookupSide ($a_type, $a_user=0, $a_block_id=0)
	Lookup side. More...

static	_writeSide ($a_type, $a_value, $a_user=0, $a_block_id=0)
	Write side to database. More...

static	_deleteSettingsOfUser ($a_user)
	Delete block settings of user. More...

static	_deleteSettingsOfBlock ($a_block_id, $a_block_type)
	Delete block settings of block. More...

static	cloneSettingsOfBlock (string $block_type, int $block_id, int $new_block_id)
	Clone block settings. More...

Static Public Attributes
static	$setting = array()

static	$pd_preloaded = false

Detailed Description

Block Setting class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 31 of file class.ilBlockSetting.php.

Member Function Documentation

◆ _deleteSettingsOfBlock()

static ilBlockSetting::_deleteSettingsOfBlock	(	$a_block_id,
		$a_block_type
	)

static

Delete block settings of block.

Definition at line 251 of file class.ilBlockSetting.php.

    {
        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"));
        }
    }

References $DIC, and $ilDB.

Referenced by ilObjExternalFeed\delete().

Here is the caller graph for this function:

◆ _deleteSettingsOfUser()

static ilBlockSetting::_deleteSettingsOfUser ( $a_user )

static

Delete block settings of user.

Definition at line 235 of file class.ilBlockSetting.php.

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

References $DIC, and $ilDB.

Referenced by ilObjUser\delete().

Here is the caller graph for this function:

◆ _lookup()

static ilBlockSetting::_lookup	(	$a_type,
		$a_setting,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Lookup setting from database.

Definition at line 40 of file class.ilBlockSetting.php.

    {
        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;
        }
    }

References $a_type, $DIC, $ilDB, and $ilSetting.

Referenced by ilObjectFeedWriter\__construct(), ilNewsItem\_getDefaultVisibilityForRefId(), _lookupDetailLevel(), _lookupSide(), ilNewsItem\_lookupUserPDPeriod(), ilNewsForContextBlockGUI\addToSettingsForm(), ilNewsForContextTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilObjMediaCastGUI\getFeedIconsHTML(), ilNewsForContextBlockGUI\getHTML(), ilNewsItem\getNewsForRefId(), ilNewsForContextBlockGUI\handleView(), ilContainerNewsSettingsGUI\initForm(), ilObjMediaCastGUI\initSettingsForm(), ilNewsForContextBlockGUI\initSettingsForm(), ilNewsItem\queryNewsForContext(), ilNewsItem\queryNewsForMultipleContexts(), ilMediaCastDataSet\readData(), ilNewsDataSet\readData(), and ilNewsForContextBlockGUI\showNews().

Here is the caller graph for this function:

◆ _lookupDetailLevel()

static ilBlockSetting::_lookupDetailLevel	(	$a_type,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Lookup detail level.

Definition at line 181 of file class.ilBlockSetting.php.

    {
        $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;
        }
    }

References $a_type, and _lookup().

Referenced by ilColumnGUI\showBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupSide()

static ilBlockSetting::_lookupSide	(	$a_type,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Lookup side.

Definition at line 215 of file class.ilBlockSetting.php.

    {
        $side = ilBlockSetting::_lookup($a_type, "side", $a_user, $a_block_id);
 
        return $side;
    }

References $a_type, and _lookup().

Referenced by ilColumnGUI\determineBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _setDefaultSetting()

static ilBlockSetting::_setDefaultSetting	(	$a_type,
		$a_setting,
		$a_value
	)

static

Sets a default setting for a block.

@global ilSetting $ilSetting

Parameters

string	$a_type
string	$a_setting
mixed	$a_value

Definition at line 81 of file class.ilBlockSetting.php.

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

References $a_type, $DIC, and $ilSetting.

◆ _unsetDefaultSetting()

static ilBlockSetting::_unsetDefaultSetting	(	$a_type,
		$a_setting
	)

static

Unsets a default setting for a block.

@global ilSetting $ilSetting

Parameters

string	$a_type
string	$a_setting

Definition at line 97 of file class.ilBlockSetting.php.

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

References $a_type, $DIC, and $ilSetting.

◆ _write()

static ilBlockSetting::_write	(	$a_type,
		$a_setting,
		$a_value,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Write setting to database.

Definition at line 154 of file class.ilBlockSetting.php.

    {
        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")
        ));
    }

References $a_type, $DIC, and $ilDB.

Referenced by _writeDetailLevel(), _writeNumber(), _writeSide(), cloneSettingsOfBlock(), ilObjFile\createProperties(), ilObjForum\createSettings(), ilNewsForContextBlockGUI\hideNotifications(), ilMediaCastDataSet\importRecord(), ilNewsDataSet\importRecord(), ilNewsForContextBlockGUI\saveSettings(), ilPDNewsBlockGUI\saveSettings(), ilObjMediaCastGUI\saveSettingsObject(), ilNewsForContextBlockGUI\showNotifications(), and ilNewsForContextBlockGUI\writeSettings().

Here is the caller graph for this function:

◆ _writeDetailLevel()

static ilBlockSetting::_writeDetailLevel	(	$a_type,
		$a_value,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Write detail level to database.

Definition at line 197 of file class.ilBlockSetting.php.

    {
        ilBlockSetting::_write($a_type, "detail", $a_value, $a_user, $a_block_id);
    }

References $a_type, and _write().

Referenced by ilColumnGUI\activateBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeNumber()

static ilBlockSetting::_writeNumber	(	$a_type,
		$a_value,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Write number to database.

Definition at line 206 of file class.ilBlockSetting.php.

    {
        ilBlockSetting::_write($a_type, "nr", $a_value, $a_user, $a_block_id);
    }

References $a_type, and _write().

Here is the call graph for this function:

◆ _writeSide()

static ilBlockSetting::_writeSide	(	$a_type,
		$a_value,
		$a_user = `0`,
		$a_block_id = `0`
	)

static

Write side to database.

Definition at line 226 of file class.ilBlockSetting.php.

    {
        ilBlockSetting::_write($a_type, "side", $a_value, $a_user, $a_block_id);
    }

References $a_type, and _write().

Here is the call graph for this function:

◆ cloneSettingsOfBlock()

static ilBlockSetting::cloneSettingsOfBlock	(	string	$block_type,
		int	$block_id,
		int	$new_block_id
	)

static

Clone block settings.

Parameters

string	$block_type
int	$block_id
int	$new_block_id

Definition at line 271 of file class.ilBlockSetting.php.

    {
        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);
        }
    }

References $DIC, and _write().

Here is the call graph for this function:

◆ preloadPDBlockSettings()

static ilBlockSetting::preloadPDBlockSettings ( )

static

Preload pd info.

Parameters

return

Definition at line 111 of file class.ilBlockSetting.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        if (!self::$pd_preloaded) {
            $blocks = array("pdbookm", "pdcal", "pdfeedb", "pditems",
                "pdmail", "pdnews", "pdnotes", "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;
        }
    }

References Vendor\Package\$b, $DIC, $ilDB, and $ilUser.

Field Documentation

◆ $pd_preloaded

ilBlockSetting::$pd_preloaded = false

static

Definition at line 34 of file class.ilBlockSetting.php.

◆ $setting

ilBlockSetting::$setting = array()

static

Definition at line 33 of file class.ilBlockSetting.php.

The documentation for this class was generated from the following file:

Services/Block/classes/class.ilBlockSetting.php

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ _deleteSettingsOfBlock()

◆ _deleteSettingsOfUser()

◆ _lookup()

◆ _lookupDetailLevel()

◆ _lookupSide()

◆ _setDefaultSetting()

◆ _unsetDefaultSetting()

◆ _write()

◆ _writeDetailLevel()

◆ _writeNumber()

◆ _writeSide()

◆ cloneSettingsOfBlock()

◆ preloadPDBlockSettings()

Field Documentation

◆ $pd_preloaded

◆ $setting