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

Public Member Functions
	setDomains (array $domains)
	getDomains ()
	isEnabled ()
	isEnabledForDomain (string $a_domain)
	setEnabled (bool $stat)
	save ()

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	read ()
	read settings More...

Static Protected Attributes
static	$instance = null

Private Member Functions
	__construct ()
	read settings More...

Private Attributes
ilSetting	$settings
bool	$enabled = false
array	$domains = array()

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 Description of class class

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilPublicSectionSettings::__construct ( )

private

read settings

Definition at line 42 of file class.ilPublicSectionSettings.php.

References $DIC, read(), and ILIAS\Repository\settings().

    {
        global $DIC;

        $this->settings = $DIC->settings();
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

getDomains()

ilPublicSectionSettings::getDomains

(

)

Returns

string[]

Definition at line 70 of file class.ilPublicSectionSettings.php.

References $domains.

Referenced by isEnabledForDomain(), and save().

                                : array
    {
        return $this->domains;
    }

Here is the caller graph for this function:

getInstance()

static ilPublicSectionSettings::getInstance ( )

static

Definition at line 50 of file class.ilPublicSectionSettings.php.

Referenced by ilRepositoryGUI\executeCommand(), ilInitialisation\handleAuthenticationFail(), ilStartUpGUI\initStartUpTemplate(), ilStartUpGUI\processIndexPHP(), ilObjSystemFolderGUI\saveBasicSettingsObject(), ilObjSystemFolderGUI\showBasicSettingsObject(), ilStartUpGUI\showLogout(), and ilStartUpGUI\showRegistrationLinks().

                                        : ilPublicSectionSettings
    {
        if (!self::$instance) {
            self::$instance = new self();
        }
        return self::$instance;
    }

Here is the caller graph for this function:

isEnabled()

ilPublicSectionSettings::isEnabled

(

)

Definition at line 75 of file class.ilPublicSectionSettings.php.

References $enabled.

Referenced by save().

                               : bool
    {
        return $this->enabled;
    }

Here is the caller graph for this function:

isEnabledForDomain()

ilPublicSectionSettings::isEnabledForDomain

(

string

$a_domain

)

Definition at line 80 of file class.ilPublicSectionSettings.php.

References getDomains().

                                                        : bool
    {
        if (!$this->enabled) {
            return false;
        }
        if (count($this->domains)) {
            if (in_array(trim($a_domain), $this->getDomains())) {
                return true;
            } else {
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

read()

ilPublicSectionSettings::read ( )

protected

read settings

Definition at line 109 of file class.ilPublicSectionSettings.php.

References ILIAS\Repository\settings().

Referenced by __construct().

                             : void
    {
        $this->enabled = (bool) $this->settings->get('pub_section', (string) $this->enabled);
        $domains = $this->settings->get('pub_section_domains', serialize($this->domains));
        $this->domains = (array) unserialize($domains);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilPublicSectionSettings::save

(

)

Definition at line 100 of file class.ilPublicSectionSettings.php.

References getDomains(), isEnabled(), and ILIAS\Repository\settings().

                          : void
    {
        $this->settings->set('pub_section', (string) $this->isEnabled());
        $this->settings->set('pub_section_domains', serialize($this->getDomains()));
    }

Here is the call graph for this function:

setDomains()

ilPublicSectionSettings::setDomains

(

array

$domains

)

Parameters

string[]

$domains

Definition at line 61 of file class.ilPublicSectionSettings.php.

References $domains.

                                              : void
    {
        $this->domains = $domains;
    }

setEnabled()

ilPublicSectionSettings::setEnabled

(

bool

$stat

)

Definition at line 95 of file class.ilPublicSectionSettings.php.

                                          : void
    {
        $this->enabled = $stat;
    }

Field Documentation

$domains

array ilPublicSectionSettings::$domains = array()

private

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

Referenced by getDomains(), and setDomains().

$enabled

bool ilPublicSectionSettings::$enabled = false

private

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

Referenced by isEnabled().

$instance

ilPublicSectionSettings::$instance = null

staticprotected

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

$settings

ilSetting ilPublicSectionSettings::$settings

private

Definition at line 30 of file class.ilPublicSectionSettings.php.

---

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

• components/ILIAS/Init/classes/class.ilPublicSectionSettings.php