ilECSServerSettings Class Reference

Collection of ECS settings. More...

Collaboration diagram for ilECSServerSettings:

Public Member Functions
	activeServerExists ()
	Check if there is any active server. More...
	serverExists ()
	Check if there is any server. More...
	getServers (int $server_type)
	Get servers The function must be called with ALL_SERVER, ACTIVE_SERVER or INACTIVE_SERVER. More...

Static Public Member Functions
static	getInstance ()
	Get singleton instance. More...

Data Fields
const	ALL_SERVER = 0
const	ACTIVE_SERVER = 1
const	INACTIVE_SERVER = 2

Protected Member Functions
	__construct ()
	Singleton contructor. More...

Private Member Functions
	readServers ()
	Read all servers. More...

Private Attributes
ilDBInterface	$db
array	$servers

Static Private Attributes
static ilECSServerSettings	$instance

Detailed Description

Collection of ECS settings.

Author

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

Per Pascal Seeland pasca.nosp@m.l.se.nosp@m.eland.nosp@m.@tik.nosp@m..uni-.nosp@m.stut.nosp@m.tgart.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilECSServerSettings::__construct ( )

protected

Singleton contructor.

Definition at line 43 of file class.ilECSServerSettings.php.

References $DIC, and readServers().

    {
        global $DIC;

        $this->db = $DIC->database();

        $this->readServers();
    }

Here is the call graph for this function:

Member Function Documentation

activeServerExists()

ilECSServerSettings::activeServerExists

(

)

Check if there is any active server.

Returns

bool

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

References getServers().

                                        : bool
    {
        return count($this->getServers(static::ACTIVE_SERVER)) ? true : false;
    }

Here is the call graph for this function:

getInstance()

static ilECSServerSettings::getInstance ( )

static

Get singleton instance.

Returns

ilECSServerSettings

Definition at line 57 of file class.ilECSServerSettings.php.

Referenced by ilAuthUtils\_getActiveAuthModes(), ilECSObjectSettings\_handleDelete(), ilInfoScreenGUI\addMetaDataSections(), ilECSSettingsGUI\communities(), ilECSSetting\ecsConfigured(), ilECSSettingsGUI\exportMappings(), ilAdvancedMDRecordGUI\handleECSDefinitions(), ilECSSettingsGUI\imported(), ilECSSettingsGUI\importMappings(), ilAuthProviderECS\initECSServices(), ilECSObjectSettings\isActive(), ilECSSettingsGUI\overview(), ilECSSettingsGUI\readAll(), ilECSSettingsGUI\refreshParticipants(), ilCronEcsTaskScheduler\run(), ilECSSettingsGUI\setSubTabs(), and ilECSSettingsGUI\updateCommunities().

                                        : ilECSServerSettings
    {
        return self::$instance ?? (self::$instance = new ilECSServerSettings());
    }

Here is the caller graph for this function:

getServers()

ilECSServerSettings::getServers

(

int

$server_type

)

Get servers The function must be called with ALL_SERVER, ACTIVE_SERVER or INACTIVE_SERVER.

Returns

ilECSSetting[]

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

References $server, $servers, and ilECSSetting\isEnabled().

Referenced by activeServerExists(), ilECSServerTableGUI\parse(), and serverExists().

                                                : array
    {
        switch ($server_type) {
            case static::ALL_SERVER:
                return $this->servers;
                break;
            case static::ACTIVE_SERVER:
                return array_filter($this->servers, static fn (ilECSSetting $server) => $server->isEnabled());
                break;
            case static::INACTIVE_SERVER:
                return array_filter($this->servers, static fn (ilECSSetting $server) => !$server->isEnabled());
                break;
            default:
                throw new InvalidArgumentException();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readServers()

ilECSServerSettings::readServers ( )

private

Read all servers.

Definition at line 104 of file class.ilECSServerSettings.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilECSSetting\getInstanceByServerId(), and ILIAS\Repository\int().

Referenced by __construct().

                                  : void
    {
        $query = 'SELECT server_id FROM ecs_server ' .
            'ORDER BY title ';
        $res = $this->db->query($query);

        $this->servers = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $server_id = (int) $row->server_id;
            $this->servers[$server_id] = ilECSSetting::getInstanceByServerId($server_id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

serverExists()

ilECSServerSettings::serverExists

(

)

Check if there is any server.

Definition at line 74 of file class.ilECSServerSettings.php.

References getServers().

                                  : bool
    {
        return count($this->getServers(static::ALL_SERVER)) ? true : false;
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilECSServerSettings::$db

private

Definition at line 34 of file class.ilECSServerSettings.php.

$instance

ilECSServerSettings ilECSServerSettings::$instance

staticprivate

Definition at line 31 of file class.ilECSServerSettings.php.

$servers

array ilECSServerSettings::$servers

private

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

Referenced by getServers().

ACTIVE_SERVER

const ilECSServerSettings::ACTIVE_SERVER = 1

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

Referenced by ilAuthProviderECS\doAuthentication(), ilECSSettingsGUI\readAll(), ilCronEcsTaskScheduler\run(), and ilECSSettingsGUI\updateCommunities().

ALL_SERVER

const ilECSServerSettings::ALL_SERVER = 0

Definition at line 27 of file class.ilECSServerSettings.php.

Referenced by ilECSSettingsGUI\communities(), ilECSSettingsGUI\exportMappings(), ilECSSettingsGUI\importMappings(), ilECSServerTableGUI\parse(), and ilECSSettingsGUI\refreshParticipants().

INACTIVE_SERVER

const ilECSServerSettings::INACTIVE_SERVER = 2

Definition at line 29 of file class.ilECSServerSettings.php.

---

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

• Services/WebServices/ECS/classes/class.ilECSServerSettings.php