ilDashboardSidePanelSettingsRepository Class Reference

Dashboard side panel settings Repo. More...

Collaboration diagram for ilDashboardSidePanelSettingsRepository:

Public Member Functions
	__construct (ilSetting $dashboard_settings=null)
	Constructor. More...
	getValidModules ()
	Get valid modules. More...
	enable (string $mod, bool $active)
	Enable. More...
	isEnabled (string $mod)
	Is enabled. More...

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

Protected Member Functions
	isValidModule (string $mod)

Detailed Description

Dashboard side panel settings Repo.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilDashboardSidePanelSettingsRepository::__construct

(

ilSetting

$dashboard_settings = null

)

Constructor.

Definition at line 20 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
	)

Enable.

Parameters

string	$mod
bool	$active

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

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

References isValidModule().

Here is the call graph for this function:

getValidModules()

ilDashboardSidePanelSettingsRepository::getValidModules

(

)

Get valid modules.

Returns

array

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

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

References CALENDAR, MAIL, NEWS, and TASKS.

Referenced by isValidModule().

Here is the caller graph for this function:

isEnabled()

ilDashboardSidePanelSettingsRepository::isEnabled

(

string

$mod

)

Is enabled.

Parameters

string

$mod

Returns

bool

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

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

References isValidModule().

Here is the call graph for this function:

isValidModule()

ilDashboardSidePanelSettingsRepository::isValidModule ( string  $mod )

protected

Parameters

string

$mod

Returns

bool

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

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

References getValidModules().

Referenced by enable(), and isEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

CALENDAR

const ilDashboardSidePanelSettingsRepository::CALENDAR = "cal"

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

Referenced by getValidModules().

MAIL

const ilDashboardSidePanelSettingsRepository::MAIL = "mail"

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

Referenced by getValidModules().

NEWS

const ilDashboardSidePanelSettingsRepository::NEWS = "news"

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

Referenced by getValidModules().

TASKS

const ilDashboardSidePanelSettingsRepository::TASKS = "task"

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

Referenced by getValidModules().

---

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

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