ilDashboardSidePanelSettingsRepository Class Reference

Collaboration diagram for ilDashboardSidePanelSettingsRepository:

Public Member Functions
	__construct (protected readonly ilSetting $setting=new ilSetting('dash'))
	getValidModules ()
	setPositions (array $positions)
	getPositions ()
	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)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDashboardSidePanelSettingsRepository::__construct

(

protected readonly ilSetting

$setting = new ilSetting('dash')

)

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

    {
    }

Member Function Documentation

enable()

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

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

                                                     : void
    {
        if ($this->isValidModule($mod)) {
            $this->setting->set('enable_' . $mod, $active ? '1' : '0');
        }
    }

References isValidModule().

Here is the call graph for this function:

getPositions()

ilDashboardSidePanelSettingsRepository::getPositions

(

)

Returns

string[]

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

                                  : array
    {
        $positions = $this->setting->get('side_panel_positions', '');
        $modules = [];
        if ($positions !== '') {
            $modules = unserialize($positions, ['allowed_classes' => false]);
        }
        $all_modules = $this->getValidModules();
        foreach ($all_modules as $mod) {
            if (!in_array($mod, $modules, true)) {
                $modules[] = $mod;
            }
        }
        return $modules;
    }

References getValidModules().

Here is the call graph for this function:

getValidModules()

ilDashboardSidePanelSettingsRepository::getValidModules ( )

final

Returns

string[]

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

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

References CALENDAR, MAIL, NEWS, and TASKS.

Referenced by getPositions(), and isValidModule().

Here is the caller graph for this function:

isEnabled()

ilDashboardSidePanelSettingsRepository::isEnabled

(

string

$mod

)

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

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

References isValidModule().

Here is the call graph for this function:

isValidModule()

ilDashboardSidePanelSettingsRepository::isValidModule ( string  $mod )

finalprotected

Definition at line 72 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:

setPositions()

ilDashboardSidePanelSettingsRepository::setPositions

(

array

$positions

)

Parameters

string[]

$positions

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

                                                  : void
    {
        $this->setting->set('side_panel_positions', serialize($positions));
    }

Field Documentation

CALENDAR

const ilDashboardSidePanelSettingsRepository::CALENDAR = 'cal'

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

Referenced by getValidModules().

MAIL

const ilDashboardSidePanelSettingsRepository::MAIL = 'mail'

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

Referenced by getValidModules().

NEWS

const ilDashboardSidePanelSettingsRepository::NEWS = 'news'

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

Referenced by getValidModules().

TASKS

const ilDashboardSidePanelSettingsRepository::TASKS = 'task'

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

Referenced by getValidModules().

---

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

• components/ILIAS/Dashboard/ItemsBlock/classes/class.ilDashboardSidePanelSettingsRepository.php