ilBlockSetting Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilBlockSetting:

Static Public Member Functions
static	_lookup (string $a_type, string $a_setting, int $a_user=0, int $a_block_id=0)
	Lookup setting from database. More...
static	preloadPDBlockSettings ()
	Preload pd info. More...
static	_write (string $a_type, string $a_setting, string $a_value, int $a_user=0, int $a_block_id=0)
	Write setting to database. More...
static	_lookupDetailLevel (string $a_type, int $a_user=0, int $a_block_id=0)
	Lookup detail level. More...
static	_writeDetailLevel (string $a_type, string $a_value, int $a_user=0, int $a_block_id=0)
static	_writeNumber (string $a_type, string $a_value, int $a_user=0, int $a_block_id=0)
static	_lookupSide (string $a_type, int $a_user=0, int $a_block_id=0)
	Lookup side. More...
static	_writeSide (string $a_type, string $a_value, int $a_user=0, int $a_block_id=0)
static	_deleteSettingsOfUser (int $a_user)
static	_deleteSettingsOfBlock (int $a_block_id, string $a_block_type)
static	cloneSettingsOfBlock (string $block_type, int $block_id, int $new_block_id)

Static Public Attributes
static array	$setting = array()
static bool	$pd_preloaded = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Block Setting class.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

_deleteSettingsOfBlock()

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

static

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

References $DIC, and $ilDB.

Referenced by ilObject\delete().

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

Here is the caller graph for this function:

_deleteSettingsOfUser()

static ilBlockSetting::_deleteSettingsOfUser ( int  $a_user )

static

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

References $DIC, and $ilDB.

Referenced by ilObjUser\delete().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

_lookup()

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

static

Lookup setting from database.

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

References $DIC, $ilDB, $ilSetting, and ILIAS\LTI\ToolProvider\$key.

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

     : ?string {
        global $DIC;

        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();

        $key = $a_type . ":" . $a_setting . ":" . $a_user . ":" . $a_block_id;
        if (isset(self::$setting[$key])) {
            return (string) 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, null)) {
            self::$setting[$key] = $ilSetting->get('block_default_setting_' . $a_type . '_' . $a_setting, null);
            return $ilSetting->get('block_default_setting_' . $a_type . '_' . $a_setting, null);
        } else {
            self::$setting[$key] = false;
            return null;
        }
    }

Here is the caller graph for this function:

_lookupDetailLevel()

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

static

Lookup detail level.

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

     : int {
        $detail = self::_lookup($a_type, "detail", $a_user, $a_block_id);

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

        return (int) $detail;
    }

_lookupSide()

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

static

Lookup side.

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

References _lookup().

Referenced by ilColumnGUI\determineBlocks().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_write()

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

static

Write setting to database.

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

References $DIC, and $ilDB.

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

     : void {
        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($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($a_block_id, "integer"),
            $ilDB->quote($a_value, "text")
        ));
    }

Here is the caller graph for this function:

_writeDetailLevel()

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

static

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

References _write().

Referenced by ilColumnGUI\activateBlock().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_writeNumber()

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

static

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

References _write().

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

Here is the call graph for this function:

_writeSide()

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

static

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

References _write().

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

Here is the call graph for this function:

cloneSettingsOfBlock()

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

static

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

References $DIC.

Referenced by ilContainer\_exportContainerSettings().

     : void {
        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, (string) $rec["setting"], (string) $rec["value"], 0, $new_block_id);
        }
    }

Here is the caller graph for this function:

preloadPDBlockSettings()

static ilBlockSetting::preloadPDBlockSettings ( )

static

Preload pd info.

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

References Vendor\Package\$b, $DIC, $ilDB, $ilUser, ILIAS\LTI\ToolProvider\$key, and ILIAS\LTI\ToolProvider\$settings.

Referenced by ilDashboardGUI\show().

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

Here is the caller graph for this function:

Field Documentation

$pd_preloaded

bool ilBlockSetting::$pd_preloaded = false

static

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

$setting

array ilBlockSetting::$setting = array()

static

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

---

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

• Services/Block/classes/class.ilBlockSetting.php