ilDashboardSidePanelSettingsRepository 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 ilDashboardSidePanelSettingsRepository:

Public Member Functions
	__construct (ilSetting $dashboard_settings=null)
	getValidModules ()
	enable (string $mod, bool $active)
	isEnabled (string $mod)

Data Fields
const	CALENDAR = "cal"
const	NEWS = "news"
const	MAIL = "mail"
const	TASKS = "task"

Protected Member Functions
	isValidModule (string $mod)

Protected Attributes
ilSetting	$setting

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

Definition at line 19 of file class.ilDashboardSidePanelSettingsRepository.php.

Constructor & Destructor Documentation

__construct()

ilDashboardSidePanelSettingsRepository::__construct

(

ilSetting

$dashboard_settings = null

)

Definition at line 28 of file class.ilDashboardSidePanelSettingsRepository.php.

    {
        $this->setting = is_null($dashboard_settings)
            ? new ilSetting("dash")
            : $dashboard_settings;
    }

Member Function Documentation

enable()

ilDashboardSidePanelSettingsRepository::enable	(	string	$mod,
		bool	$active
	)

Definition at line 52 of file class.ilDashboardSidePanelSettingsRepository.php.

References isValidModule().

                                                     : void
    {
        if ($this->isValidModule($mod)) {
            $this->setting->set("enable_" . $mod, (int) $active);
        }
    }

Here is the call graph for this function:

getValidModules()

ilDashboardSidePanelSettingsRepository::getValidModules

(

)

Definition at line 35 of file class.ilDashboardSidePanelSettingsRepository.php.

Referenced by isValidModule().

                                     : array
    {
        return [
            self::CALENDAR,
            self::NEWS,
            self::MAIL,
            self::TASKS
        ];
    }

Here is the caller graph for this function:

isEnabled()

ilDashboardSidePanelSettingsRepository::isEnabled

(

string

$mod

)

Definition at line 60 of file class.ilDashboardSidePanelSettingsRepository.php.

References isValidModule().

                                          : bool
    {
        if ($this->isValidModule($mod)) {
            return (bool) $this->setting->get("enable_" . $mod, true);
        }
        return false;
    }

Here is the call graph for this function:

isValidModule()

ilDashboardSidePanelSettingsRepository::isValidModule ( string  $mod )

protected

Definition at line 45 of file class.ilDashboardSidePanelSettingsRepository.php.

References getValidModules().

Referenced by enable(), and isEnabled().

                                                 : bool
    {
        return in_array($mod, $this->getValidModules());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$setting

ilSetting ilDashboardSidePanelSettingsRepository::$setting

protected

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

CALENDAR

const ilDashboardSidePanelSettingsRepository::CALENDAR = "cal"

Definition at line 21 of file class.ilDashboardSidePanelSettingsRepository.php.

MAIL

const ilDashboardSidePanelSettingsRepository::MAIL = "mail"

Definition at line 23 of file class.ilDashboardSidePanelSettingsRepository.php.

NEWS

const ilDashboardSidePanelSettingsRepository::NEWS = "news"

Definition at line 22 of file class.ilDashboardSidePanelSettingsRepository.php.

TASKS

const ilDashboardSidePanelSettingsRepository::TASKS = "task"

Definition at line 24 of file class.ilDashboardSidePanelSettingsRepository.php.

---

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

• Services/Dashboard/ItemsBlock/classes/class.ilDashboardSidePanelSettingsRepository.php