ILIAS  release_8 Revision v8.24
ilPublicSectionSettings Class Reference

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

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 9 of file class.ilPublicSectionSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilPublicSectionSettings::__construct ( )
private

read settings

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

29 {
30 global $DIC;
31
32 $this->settings = $DIC->settings();
33 $this->read();
34 }
global $DIC
Definition: feed.php:28

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

+ Here is the call graph for this function:

Member Function Documentation

◆ getDomains()

ilPublicSectionSettings::getDomains ( )
Returns
string[]

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

56 : array
57 {
58 return $this->domains;
59 }

References $domains.

Referenced by isEnabledForDomain(), and save().

+ Here is the caller graph for this function:

◆ getInstance()

static ilPublicSectionSettings::getInstance ( )
static

◆ isEnabled()

ilPublicSectionSettings::isEnabled ( )

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

61 : bool
62 {
63 return $this->enabled;
64 }

References $enabled.

Referenced by save().

+ Here is the caller graph for this function:

◆ isEnabledForDomain()

ilPublicSectionSettings::isEnabledForDomain ( string  $a_domain)

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

66 : bool
67 {
68 if (!$this->enabled) {
69 return false;
70 }
71 if (count($this->domains)) {
72 if (in_array(trim($a_domain), $this->getDomains())) {
73 return true;
74 } else {
75 return false;
76 }
77 }
78 return true;
79 }

References getDomains().

+ Here is the call graph for this function:

◆ read()

ilPublicSectionSettings::read ( )
protected

read settings

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

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

References $domains, $enabled, and ILIAS\Repository\settings().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ save()

ilPublicSectionSettings::save ( )

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

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

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

+ Here is the call graph for this function:

◆ setDomains()

ilPublicSectionSettings::setDomains ( array  $domains)
Parameters
string[]$domains

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

47 : void
48 {
49 $this->domains = $domains;
50 }

References $domains.

◆ setEnabled()

ilPublicSectionSettings::setEnabled ( bool  $stat)

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

81 : void
82 {
83 $this->enabled = $stat;
84 }

Field Documentation

◆ $domains

array ilPublicSectionSettings::$domains = array()
private

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

Referenced by getDomains(), read(), and setDomains().

◆ $enabled

bool ilPublicSectionSettings::$enabled = false
private

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

Referenced by isEnabled(), and read().

◆ $instance

ilPublicSectionSettings::$instance = null
staticprotected

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

Referenced by getInstance().

◆ $settings

ilSetting ilPublicSectionSettings::$settings
private

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


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