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 ()
	Get servers. More...
	readInactiveServers ()
	Read inactive servers ilDB $ilDB. More...

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

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

Private Member Functions
	readActiveServers ()
	Read all actice servers ilDB $ilDB. More...

Private Attributes
	$servers = array()

Static Private Attributes
static	$instance = null

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilECSServerSettings::__construct ( )

protected

Singleton contructor.

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

References readActiveServers().

    {
        $this->readActiveServers();
    }

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().

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

Here is the call graph for this function:

getInstance()

static ilECSServerSettings::getInstance ( )

static

Get singleton instance.

Returns

ilECSServerSettings

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

Referenced by ilAuthUtils\_getActiveAuthModes(), ilECSObjectSettings\_handleDelete(), ilInfoScreenGUI\addObjectSections(), ilECSSettingsGUI\communities(), ilECSSettingsGUI\exportMappings(), ilAdvancedMDRecordGUI\handleECSDefinitions(), ilECSSettingsGUI\imported(), ilECSSettingsGUI\importMappings(), ilAuthProviderECS\initECSServices(), ilAuthContainerECS\initECSServices(), ilECSObjectSettings\isActive(), ilECSSettingsGUI\overview(), ilECSSettingsGUI\readAll(), ilECSSettingsGUI\refreshParticipants(), ilECSSettingsGUI\setSubTabs(), ilECSTaskScheduler\start(), ilECSTaskScheduler\startExecution(), and ilECSSettingsGUI\updateCommunities().

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

Here is the caller graph for this function:

getServers()

ilECSServerSettings::getServers

(

)

Get servers.

Returns

array ilECSSetting

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

References $servers.

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

    {
        return (array) $this->servers;
    }

Here is the caller graph for this function:

readActiveServers()

ilECSServerSettings::readActiveServers ( )

private

Read all actice servers ilDB $ilDB.

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and ilECSSetting\getInstanceByServerId().

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT server_id FROM ecs_server ' .
            'WHERE active =  ' . $ilDB->quote(1, 'integer') . ' ' .
            'ORDER BY title ';
        $res = $ilDB->query($query);

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

Here is the call graph for this function:

Here is the caller graph for this function:

readInactiveServers()

ilECSServerSettings::readInactiveServers

(

)

Read inactive servers ilDB $ilDB.

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and ilECSSetting\getInstanceByServerId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT server_id FROM ecs_server ' .
            'WHERE active =  ' . $ilDB->quote(0, 'integer') . ' ' .
            'ORDER BY title ';
        $res = $ilDB->query($query);

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

Here is the call graph for this function:

serverExists()

ilECSServerSettings::serverExists

(

)

Check if there is any server.

Returns

bool

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

References getServers().

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

Here is the call graph for this function:

Field Documentation

$instance

ilECSServerSettings::$instance = null

staticprivate

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

$servers

ilECSServerSettings::$servers = array()

private

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

Referenced by getServers().

---

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

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