ilECSSetting Class Reference

Collaboration diagram for ilECSSetting:

Public Member Functions
	setTitle (string $a_title)
	Set title. More...
	getTitle ()
	Get title. More...
	setAuthType ($a_auth_type)
	Set auth type. More...
	getAuthType ()
	Get auth type. More...
	setAuthUser ($a_user)
	Set apache auth user. More...
	getAuthUser ()
	Get apache auth user. More...
	setAuthPass ($a_pass)
	Set Apache auth password. More...
	getAuthPass ()
	Get auth password. More...
	getServerId ()
	Get current server id. More...
	setEnabledStatus (bool $status)
	en/disable ecs functionality More...
	isEnabled ()
	is enabled More...
	setServer (string $a_server)
	set server More...
	getServer ()
	get server More...
	getServerURI ()
	get complete server uri More...
	setProtocol (int $a_prot)
	set protocol More...
	getProtocol ()
	get protocol More...
	setPort (int $a_port)
	set port More...
	getPort ()
	get port More...
	setClientCertPath ($a_path)
	getClientCertPath ()
	get certificate path More...
	setCACertPath (string $a_ca)
	set ca cert path More...
	getCACertPath ()
	get ca cert path More...
	getKeyPath ()
	get key path More...
	setKeyPath (string $a_path)
	set key path More...
	getKeyPassword ()
	get key password More...
	setKeyPassword (string $a_pass)
	set key password More...
	setImportId (int $a_id)
	set import id Object of category, that store new remote courses More...
	getImportId ()
	get import id More...
	setCertSerialNumber (string $a_cert_serial)
	set cert serial number More...
	getCertSerialNumber ()
	get cert serial number More...
	getGlobalRole ()
	get global role More...
	setGlobalRole (int $a_role_id)
	set default global role More...
	setDuration (int $a_duration)
	set Duration More...
	getDuration ()
	get duration More...
	getUserRecipients ()
	Get new user recipients. More...
	getUserRecipientsAsString ()
	Get new user recipients. More...
	setUserRecipients (array $a_logins)
	set user recipients More...
	getEContentRecipients ()
	get Econtent recipients More...
	getEContentRecipientsAsString ()
	get EContent recipients as string More...
	setEContentRecipients (array $a_logins)
	set EContent recipients More...
	getApprovalRecipients ()
	get approval recipients More...
	getApprovalRecipientsAsString ()
	get approval recipients as string More...
	setApprovalRecipients (array $a_rcp)
	set approval recipients More...
	validate ()
	Validate settings. More...
	checkImportId ()
	check import id More...
	save ()
	save settings More...
	update ()
	Update setting. More...
	delete ()
	Delete. More...
	fetchCertificateExpiration ()
	Fetch validity (expired date) More...
	__clone ()
	Overwritten clone method Reset all connection settings. More...

Static Public Member Functions
static	getInstanceByServerId (int $a_server_id)
	Get singleton instance per server. More...
static	lookupAuthMode ()
	Lookup auth mode. More...
static	ecsConfigured ()
	Checks if an ecs server is configured. More...

Data Fields
const	DEFAULT_AUTH_MODE = 'ldap'
const	ERROR_EXTRACT_SERIAL = 'ecs_error_extract_serial'
const	ERROR_REQUIRED = 'fill_out_all_required_fields'
const	ERROR_INVALID_IMPORT_ID = 'ecs_check_import_id'
const	ERROR_CERT_EXPIRED = 'ecs_certificate_expired'
const	AUTH_CERTIFICATE = 1
const	AUTH_APACHE = 2
const	DEFAULT_DURATION = 6
const	PROTOCOL_HTTP = 0
const	PROTOCOL_HTTPS = 1

Static Protected Attributes
static array	$instances = null

Private Member Functions
	__construct ($a_server_id=0)
	Singleton contructor. More...
	fetchSerialID ()
	Fetch serial ID from cert. More...
	read ()
	Read settings. More...

Private Attributes
int	$server_id
bool	$active = false
string	$title = ''
int	$auth_type = self::AUTH_CERTIFICATE
string	$server = ''
int	$protocol = self::PROTOCOL_HTTPS
int	$port = 0
string	$client_cert_path = ''
string	$ca_cert_path = ''
string	$cert_serial_number = ''
string	$key_path = ''
string	$key_password = ''
int	$import_id = 0
int	$global_role = 0
int	$duration = 0
string	$auth_user = ''
string	$auth_pass = ''
array	$user_recipients = []
array	$econtent_recipients = []
array	$approval_recipients = []
ilDBInterface	$db
ilLogger	$log
ilObjectDataCache	$objDataCache
ilTree	$tree

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilECSSetting::__construct (   $a_server_id = 0 )

private

Singleton contructor.

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->log = $DIC->logger()->wsrv();
        $this->objDataCache = $DIC['ilObjDataCache'];
        $this->tree = $DIC->repositoryTree();
 
        $this->server_id = $a_server_id;
        $this->read();
    }

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

__clone()

ilECSSetting::__clone

(

)

Overwritten clone method Reset all connection settings.

Definition at line 754 of file class.ilECSSetting.php.

    {
        $this->server_id = 0;
        $this->setTitle($this->getTitle() . ' (Copy)');
        $this->setEnabledStatus(false);
        $this->setServer('');
        $this->setProtocol(self::PROTOCOL_HTTPS);
        $this->setPort(0);
        $this->setClientCertPath('');
        $this->setKeyPath('');
        $this->setKeyPassword('');
        $this->setCACertPath('');
        $this->setCertSerialNumber('');
        $this->setAuthType(self::AUTH_CERTIFICATE);
        $this->setAuthUser('');
        $this->setAuthPass('');
    }

References getTitle(), setAuthPass(), setAuthType(), setAuthUser(), setCACertPath(), setCertSerialNumber(), setClientCertPath(), setEnabledStatus(), setKeyPassword(), setKeyPath(), setPort(), setProtocol(), setServer(), and setTitle().

Here is the call graph for this function:

checkImportId()

ilECSSetting::checkImportId

(

)

check import id

Definition at line 543 of file class.ilECSSetting.php.

                                   : bool
    {
        if (!$this->getImportId()) {
            return false;
        }
        if ($this->objDataCache->lookupType($this->objDataCache->lookupObjId($this->getImportId())) !== 'cat') {
            return false;
        }
        if ($this->tree->isDeleted($this->getImportId())) {
            return false;
        }
        return true;
    }

References getImportId().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilECSSetting::delete

(

)

Delete.

Definition at line 626 of file class.ilECSSetting.php.

                            : bool
    {
        // --- cascading delete
        ilECSCmsData::deleteByServerId($this->getServerId());
 
        //TODO fix properly
        ilECSCommunityCache::getInstance($this->getServerId(), -1)->deleteByServerId($this->getServerId());
 
        ilECSDataMappingSettings::getInstanceByServerId($this->getServerId())->delete();
 
        (new ilECSEventQueueReader($this))->deleteAll();
 
        ilECSNodeMappingAssignment::deleteByServerId($this->getServerId());
 
        $query = 'DELETE FROM ecs_events' .
            ' WHERE server_id = ' . $this->db->quote($this->getServerId(), 'integer');
        $this->db->manipulate($query);
 
        ilECSExportManager::getInstance()->deleteByServer($this->getServerId());
 
        //TODO check which one we need
        ilECSImportManager::getInstance()->deleteByServer($this->getServerId());
 
        // resetting server id to flag items in imported list
        ilECSImportManager::getInstance()->resetServerId($this->getServerId());
 
        $this->db->manipulate(
            'DELETE FROM ecs_server ' .
            'WHERE server_id = ' . $this->db->quote($this->getServerId(), 'integer')
        );
 
        $this->server_id = 0;
        return true;
    }

References ilECSNodeMappingAssignment\deleteByServerId(), ilECSCmsData\deleteByServerId(), ilECSExportManager\getInstance(), ilECSImportManager\getInstance(), ilECSCommunityCache\getInstance(), ilECSDataMappingSettings\getInstanceByServerId(), and getServerId().

Here is the call graph for this function:

ecsConfigured()

static ilECSSetting::ecsConfigured ( )

static

Checks if an ecs server is configured.

Deprecated:

use ilECSServerSettings::getInstance()->serverExists()

Definition at line 110 of file class.ilECSSetting.php.

                                          : bool
    {
        return ilECSServerSettings::getInstance()->serverExists();
    }

References ilECSServerSettings\getInstance().

Referenced by ilAdvancedMDRecord\_getAllRecordsByObjectType(), and ilAdvancedMDRecord\_getAssignableObjectTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

fetchCertificateExpiration()

ilECSSetting::fetchCertificateExpiration

(

)

Fetch validity (expired date)

Definition at line 665 of file class.ilECSSetting.php.

                                                : ?ilDateTime
    {
        if ($this->getAuthType() !== self::AUTH_CERTIFICATE) {
            return null;
        }
 
        if ((function_exists('openssl_x509_parse') &&
                ($cert = openssl_x509_parse('file://' . $this->getClientCertPath())) &&
                        $cert && isset($cert['validTo_time_t'])) && $cert['validTo_time_t']) {
            $dt = new ilDateTime($cert['validTo_time_t'], IL_CAL_UNIX);
 
            $this->log->debug('Certificate expires at: ' . ilDatePresentation::formatDate($dt));
            return $dt;
        }
        return null;
    }

References ilDatePresentation\formatDate(), getAuthType(), getClientCertPath(), and IL_CAL_UNIX.

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

fetchSerialID()

ilECSSetting::fetchSerialID ( )

private

Fetch serial ID from cert.

Definition at line 685 of file class.ilECSSetting.php.

                                    : bool
    {
        if (function_exists('openssl_x509_parse') && ($cert = openssl_x509_parse('file://' . $this->getClientCertPath())) && $cert && isset($cert['serialNumber']) && $cert['serialNumber']) {
            $this->setCertSerialNumber($cert['serialNumber']);
            $this->log->debug('Searial number is: ' . $cert['serialNumber']);
            return true;
        }
 
        if (!file_exists($this->getClientCertPath()) || !is_readable($this->getClientCertPath())) {
            return false;
        }
        $lines = file($this->getClientCertPath());
        $found = false;
        foreach ($lines as $line) {
            if (strpos($line, 'Serial Number:') !== false) {
                $found = true;
                $serial_line = explode(':', $line);
                $serial = trim($serial_line[1]);
                break;
            }
        }
        if ($found && isset($serial)) {
            $this->setCertSerialNumber($serial);
            return true;
        }
        return false;
    }

References getClientCertPath(), and setCertSerialNumber().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

getApprovalRecipients()

ilECSSetting::getApprovalRecipients

(

)

get approval recipients

Definition at line 476 of file class.ilECSSetting.php.

                                           : array
    {
        return $this->approval_recipients;
    }

References $approval_recipients.

Referenced by ilECSObjectSettings\sendNewContentNotification().

Here is the caller graph for this function:

getApprovalRecipientsAsString()

ilECSSetting::getApprovalRecipientsAsString

(

)

get approval recipients as string

Definition at line 484 of file class.ilECSSetting.php.

                                                   : string
    {
        return implode(',', $this->approval_recipients);
    }

Referenced by ilECSObjectSettings\sendNewContentNotification().

Here is the caller graph for this function:

getAuthPass()

ilECSSetting::getAuthPass

(

)

Get auth password.

Definition at line 175 of file class.ilECSSetting.php.

                                 : string
    {
        return $this->auth_pass;
    }

References $auth_pass.

Referenced by validate().

Here is the caller graph for this function:

getAuthType()

ilECSSetting::getAuthType

(

)

Get auth type.

Definition at line 143 of file class.ilECSSetting.php.

                                 : int
    {
        return $this->auth_type;
    }

References $auth_type.

Referenced by fetchCertificateExpiration(), and validate().

Here is the caller graph for this function:

getAuthUser()

ilECSSetting::getAuthUser

(

)

Get apache auth user.

Definition at line 159 of file class.ilECSSetting.php.

                                 : string
    {
        return $this->auth_user;
    }

References $auth_user.

Referenced by validate().

Here is the caller graph for this function:

getCACertPath()

ilECSSetting::getCACertPath

(

)

get ca cert path

Definition at line 314 of file class.ilECSSetting.php.

                                   : string
    {
        return $this->ca_cert_path;
    }

References $ca_cert_path.

Referenced by validate().

Here is the caller graph for this function:

getCertSerialNumber()

ilECSSetting::getCertSerialNumber

(

)

get cert serial number

Definition at line 383 of file class.ilECSSetting.php.

                                         : ?string
    {
        return $this->cert_serial_number;
    }

References $cert_serial_number.

getClientCertPath()

ilECSSetting::getClientCertPath

(

)

get certificate path

Definition at line 296 of file class.ilECSSetting.php.

                                       : string
    {
        return $this->client_cert_path;
    }

References $client_cert_path.

Referenced by fetchCertificateExpiration(), fetchSerialID(), and validate().

Here is the caller graph for this function:

getDuration()

ilECSSetting::getDuration

(

)

get duration

Definition at line 415 of file class.ilECSSetting.php.

                                 : int
    {
        return $this->duration ?: self::DEFAULT_DURATION;
    }

References DEFAULT_DURATION.

Referenced by validate().

Here is the caller graph for this function:

getEContentRecipients()

ilECSSetting::getEContentRecipients

(

)

get Econtent recipients

Definition at line 450 of file class.ilECSSetting.php.

                                           : array
    {
        return $this->econtent_recipients;
    }

References $econtent_recipients.

getEContentRecipientsAsString()

ilECSSetting::getEContentRecipientsAsString

(

)

get EContent recipients as string

Definition at line 458 of file class.ilECSSetting.php.

                                                   : string
    {
        return implode(',', $this->econtent_recipients);
    }

getGlobalRole()

ilECSSetting::getGlobalRole

(

)

get global role

Definition at line 391 of file class.ilECSSetting.php.

                                   : int
    {
        return $this->global_role;
    }

References $global_role.

Referenced by validate().

Here is the caller graph for this function:

getImportId()

ilECSSetting::getImportId

(

)

get import id

Definition at line 367 of file class.ilECSSetting.php.

                                 : int
    {
        return $this->import_id;
    }

References $import_id.

Referenced by checkImportId(), ilRemoteObjectBase\createFromECSEContent(), and validate().

Here is the caller graph for this function:

getInstanceByServerId()

static ilECSSetting::getInstanceByServerId ( int  $a_server_id )

static

Get singleton instance per server.

Parameters

int

$a_server_id

Returns

ilECSSetting

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

                                                                  : ilECSSetting
    {
        return self::$instances[$a_server_id] ?? (self::$instances[$a_server_id] = new ilECSSetting($a_server_id));
    }

Referenced by ilECSMappingSettingsGUI\__construct(), ilECSDataMappingSettings\__construct(), ilECSTaskScheduler\_getInstanceByServerId(), ilECSObjectSettings\_handleDelete(), ilRemoteObjectBase\createAuthResource(), ilECSServerTableGUI\fillRow(), ilRemoteObjectBase\getFullRemoteLink(), ilECSCommunityReader\getInstanceByServerId(), ilECSCategoryMapping\getMatchingCategory(), ilECSNodeMappingTreeTableGUI\getServer(), ilECSObjectSettings\handleContentUpdate(), ilECSAppEventListener\handleNewAccountCreation(), ilECSAppEventListener\initServer(), ilECSSettingsGUI\initSettings(), ilECSEContentDetails\loadFromServer(), ilECSTreeReader\read(), ilECSServerSettings\readServers(), ilRemoteObjectBase\sendNewContentNotification(), and ilECSAppEventListener\updateEnrolmentStatus().

Here is the caller graph for this function:

getKeyPassword()

ilECSSetting::getKeyPassword

(

)

get key password

Definition at line 340 of file class.ilECSSetting.php.

                                    : string
    {
        return $this->key_password;
    }

References $key_password.

Referenced by validate().

Here is the caller graph for this function:

getKeyPath()

ilECSSetting::getKeyPath

(

)

get key path

Definition at line 322 of file class.ilECSSetting.php.

                                : string
    {
        return $this->key_path;
    }

References $key_path.

Referenced by validate().

Here is the caller graph for this function:

getPort()

ilECSSetting::getPort

(

)

get port

Definition at line 283 of file class.ilECSSetting.php.

                             : int
    {
        return $this->port;
    }

References $port.

Referenced by getServerURI(), and validate().

Here is the caller graph for this function:

getProtocol()

ilECSSetting::getProtocol

(

)

get protocol

Definition at line 267 of file class.ilECSSetting.php.

                                 : int
    {
        return $this->protocol;
    }

References $protocol.

Referenced by getServerURI().

Here is the caller graph for this function:

getServer()

ilECSSetting::getServer

(

)

get server

Definition at line 216 of file class.ilECSSetting.php.

                               : string
    {
        return $this->server;
    }

References $server.

Referenced by getServerURI(), and validate().

Here is the caller graph for this function:

getServerId()

ilECSSetting::getServerId

(

)

Get current server id.

Definition at line 183 of file class.ilECSSetting.php.

                                 : int
    {
        return (int) $this->server_id;
    }

References $server_id.

Referenced by ilECSCommunityTableGUI\__construct(), ilECSCommunityReader\__construct(), ilECSObjectSettings\addMetadataToJson(), ilRemoteObjectBase\createFromECSEContent(), delete(), ilECSObjectSettings\doUpdate(), ilECSCmsTreeCommandQueueHandler\handleCreate(), ilRemoteObjectBase\handleDelete(), ilECSObjectSettings\handleSettingsForServer(), ilRemoteObjectBase\handleUpdate(), ilECSCmsTreeCommandQueueHandler\handleUpdate(), ilRemoteObjectBase\importMetadataFromJson(), read(), ilECSObjectSettings\sendNewContentNotification(), ilObjRemoteCourse\updateCustomFromECSContent(), and ilRemoteObjectBase\updateFromECSContent().

Here is the caller graph for this function:

getServerURI()

ilECSSetting::getServerURI

(

)

get complete server uri

Definition at line 224 of file class.ilECSSetting.php.

    {
        $uri = "";
        switch ($this->getProtocol()) {
            case self::PROTOCOL_HTTP:
                $uri .= 'http://';
                break;
 
            case self::PROTOCOL_HTTPS:
                $uri .= 'https://';
                break;
        }
 
        if (strpos($this->getServer(), '/') !== false) {
            $counter = 0;
            foreach ((array) explode('/', $this->getServer()) as $key => $part) {
                $uri .= $part;
                if (!$counter) {
                    $uri .= ':' . $this->getPort();
                }
                $uri .= '/';
                ++$counter;
            }
            $uri = substr($uri, 0, -1);
        } else {
            $uri .= $this->getServer();
            $uri .= (':' . $this->getPort());
        }
 
        return $uri;
    }

References $counter, getPort(), getProtocol(), getServer(), PROTOCOL_HTTP, and PROTOCOL_HTTPS.

Here is the call graph for this function:

getTitle()

ilECSSetting::getTitle

(

)

Get title.

Returns

string title

Definition at line 127 of file class.ilECSSetting.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by __clone().

Here is the caller graph for this function:

getUserRecipients()

ilECSSetting::getUserRecipients

(

)

Get new user recipients.

Definition at line 423 of file class.ilECSSetting.php.

                                       : array
    {
        return $this->user_recipients;
    }

References $user_recipients.

getUserRecipientsAsString()

ilECSSetting::getUserRecipientsAsString

(

)

Get new user recipients.

Definition at line 431 of file class.ilECSSetting.php.

                                               : string
    {
        return implode(',', $this->user_recipients);
    }

isEnabled()

ilECSSetting::isEnabled

(

)

is enabled

Definition at line 200 of file class.ilECSSetting.php.

                               : bool
    {
        return $this->active;
    }

References $active.

Referenced by validate().

Here is the caller graph for this function:

lookupAuthMode()

static ilECSSetting::lookupAuthMode ( )

static

Lookup auth mode.

Definition at line 101 of file class.ilECSSetting.php.

                                           : string
    {
        return self::DEFAULT_AUTH_MODE;
    }

References DEFAULT_AUTH_MODE.

read()

ilECSSetting::read ( )

private

Read settings.

Definition at line 716 of file class.ilECSSetting.php.

                           : void
    {
        if (!$this->getServerId()) {
            return;
        }
 
        $query = 'SELECT * FROM ecs_server ' .
            'WHERE server_id = ' . $this->db->quote($this->getServerId(), 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->setServer($row['server']);
            $this->setTitle($row['title']);
            $this->setProtocol((int) $row['protocol']);
            $this->setPort((int) $row['port']);
            $this->setClientCertPath($row['client_cert_path']);
            $this->setCACertPath($row['ca_cert_path']);
            $this->setKeyPath($row['key_path']);
            $this->setKeyPassword($row['key_password']);
            $this->setImportId((int) $row['import_id']);
            $this->setEnabledStatus((bool) $row['active']);
            if ($row['cert_serial']) {
                $this->setCertSerialNumber($row['cert_serial']);
            }
            $this->setGlobalRole((int) $row['global_role']);
            $this->econtent_recipients = explode(',', $row['econtent_rcp']);
            $this->approval_recipients = explode(',', $row['approval_rcp']);
            $this->user_recipients = explode(',', $row['user_rcp']);
            $this->setDuration((int) $row['duration']);
            $this->setAuthUser($row['auth_user']);
            $this->setAuthPass($row['auth_pass']);
            $this->setAuthType((int) $row['auth_type']);
        }
    }

References $res, ilDBConstants\FETCHMODE_ASSOC, getServerId(), setAuthPass(), setAuthType(), setAuthUser(), setCACertPath(), setCertSerialNumber(), setClientCertPath(), setDuration(), setEnabledStatus(), setGlobalRole(), setImportId(), setKeyPassword(), setKeyPath(), setPort(), setProtocol(), setServer(), and setTitle().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSSetting::save

(

)

save settings

Definition at line 560 of file class.ilECSSetting.php.

                          : void
    {
        $this->server_id = $this->db->nextId('ecs_server');
        $this->db->manipulate(
            'INSERT INTO ecs_server (server_id,active,title,protocol,server,port,auth_type,client_cert_path,ca_cert_path,' .
            'key_path,key_password,cert_serial,import_id,global_role,econtent_rcp,user_rcp,approval_rcp,duration,auth_user,auth_pass) ' .
            'VALUES (' .
            $this->db->quote($this->getServerId(), 'integer') . ', ' .
            $this->db->quote((int) $this->isEnabled(), 'integer') . ', ' .
            $this->db->quote($this->getTitle(), 'text') . ', ' .
            $this->db->quote($this->getProtocol(), 'integer') . ', ' .
            $this->db->quote($this->getServer(), 'text') . ', ' .
            $this->db->quote($this->getPort(), 'integer') . ', ' .
            $this->db->quote($this->getAuthType(), 'integer') . ', ' .
            $this->db->quote($this->getClientCertPath(), 'text') . ', ' .
            $this->db->quote($this->getCACertPath(), 'text') . ', ' .
            $this->db->quote($this->getKeyPath(), 'text') . ', ' .
            $this->db->quote($this->getKeyPassword(), 'text') . ', ' .
            $this->db->quote($this->getCertSerialNumber(), 'text') . ', ' .
            $this->db->quote($this->getImportId(), 'integer') . ', ' .
            $this->db->quote($this->getGlobalRole(), 'integer') . ', ' .
            $this->db->quote($this->getEContentRecipientsAsString(), 'text') . ', ' .
            $this->db->quote($this->getUserRecipientsAsString(), 'text') . ', ' .
            $this->db->quote($this->getApprovalRecipientsAsString(), 'text') . ', ' .
            $this->db->quote($this->getDuration(), 'integer') . ', ' .
            $this->db->quote($this->getAuthUser(), 'text') . ', ' .
            $this->db->quote($this->getAuthPass(), 'text') . ' ' .
            ')'
        );
    }

Referenced by ilECSSettingsGUI\cp().

Here is the caller graph for this function:

setApprovalRecipients()

ilECSSetting::setApprovalRecipients

(

array

$a_rcp

)

set approval recipients

Definition at line 492 of file class.ilECSSetting.php.

                                                       : void
    {
        $this->approval_recipients = $a_rcp;
    }

setAuthPass()

ilECSSetting::setAuthPass

(

$a_pass

)

Set Apache auth password.

Definition at line 167 of file class.ilECSSetting.php.

                                        : void
    {
        $this->auth_pass = $a_pass;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setAuthType()

ilECSSetting::setAuthType

(

$a_auth_type

)

Set auth type.

Definition at line 135 of file class.ilECSSetting.php.

                                             : void
    {
        $this->auth_type = $a_auth_type;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setAuthUser()

ilECSSetting::setAuthUser

(

$a_user

)

Set apache auth user.

Definition at line 151 of file class.ilECSSetting.php.

                                        : void
    {
        $this->auth_user = $a_user;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setCACertPath()

ilECSSetting::setCACertPath

(

string

$a_ca

)

set ca cert path

Parameters

string

ca cert path

Definition at line 306 of file class.ilECSSetting.php.

                                               : void
    {
        $this->ca_cert_path = $a_ca;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setCertSerialNumber()

ilECSSetting::setCertSerialNumber

(

string

$a_cert_serial

)

set cert serial number

Definition at line 375 of file class.ilECSSetting.php.

                                                              : void
    {
        $this->cert_serial_number = $a_cert_serial;
    }

Referenced by __clone(), fetchSerialID(), and read().

Here is the caller graph for this function:

setClientCertPath()

ilECSSetting::setClientCertPath

(

$a_path

)

Definition at line 288 of file class.ilECSSetting.php.

                                              : void
    {
        $this->client_cert_path = $a_path;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setDuration()

ilECSSetting::setDuration

(

int

$a_duration

)

set Duration

Definition at line 407 of file class.ilECSSetting.php.

                                                : void
    {
        $this->duration = $a_duration;
    }

Referenced by read().

Here is the caller graph for this function:

setEContentRecipients()

ilECSSetting::setEContentRecipients

(

array

$a_logins

)

set EContent recipients

Parameters

array

of user obj_ids

Definition at line 468 of file class.ilECSSetting.php.

                                                          : void
    {
        $this->econtent_recipients = $a_logins;
    }

setEnabledStatus()

ilECSSetting::setEnabledStatus

(

bool

$status

)

en/disable ecs functionality

Definition at line 192 of file class.ilECSSetting.php.

                                                  : void
    {
        $this->active = $status;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setGlobalRole()

ilECSSetting::setGlobalRole

(

int

$a_role_id

)

set default global role

Definition at line 399 of file class.ilECSSetting.php.

                                                 : void
    {
        $this->global_role = $a_role_id;
    }

Referenced by read().

Here is the caller graph for this function:

setImportId()

ilECSSetting::setImportId

(

int

$a_id

)

set import id Object of category, that store new remote courses

Definition at line 359 of file class.ilECSSetting.php.

                                          : void
    {
        $this->import_id = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

setKeyPassword()

ilECSSetting::setKeyPassword

(

string

$a_pass

)

set key password

Parameters

string

key password

Definition at line 350 of file class.ilECSSetting.php.

                                                  : void
    {
        $this->key_password = $a_pass;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setKeyPath()

ilECSSetting::setKeyPath

(

string

$a_path

)

set key path

Parameters

string

key path

Definition at line 332 of file class.ilECSSetting.php.

                                              : void
    {
        $this->key_path = $a_path;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setPort()

ilECSSetting::setPort

(

int

$a_port

)

set port

Definition at line 275 of file class.ilECSSetting.php.

                                        : void
    {
        $this->port = $a_port;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setProtocol()

ilECSSetting::setProtocol

(

int

$a_prot

)

set protocol

Definition at line 259 of file class.ilECSSetting.php.

                                            : void
    {
        $this->protocol = $a_prot;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setServer()

ilECSSetting::setServer

(

string

$a_server

)

set server

Definition at line 208 of file class.ilECSSetting.php.

                                               : void
    {
        $this->server = $a_server;
    }

References ILIAS\UI\examples\Progress\Bar\server().

Referenced by __clone(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

setTitle()

ilECSSetting::setTitle

(

string

$a_title

)

Set title.

Definition at line 118 of file class.ilECSSetting.php.

                                             : void
    {
        $this->title = $a_title;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setUserRecipients()

ilECSSetting::setUserRecipients

(

array

$a_logins

)

set user recipients

Parameters

array

of recipients (array of user login names)

Definition at line 442 of file class.ilECSSetting.php.

                                                      : void
    {
        $this->user_recipients = $a_logins;
    }

update()

ilECSSetting::update

(

)

Update setting.

Definition at line 594 of file class.ilECSSetting.php.

                            : void
    {
        $this->db->manipulate(
            'UPDATE ecs_server SET ' .
            'server_id = ' . $this->db->quote($this->getServerId(), 'integer') . ', ' .
            'active = ' . $this->db->quote((int) $this->isEnabled(), 'integer') . ', ' .
            'title = ' . $this->db->quote($this->getTitle(), 'text') . ', ' .
            'protocol = ' . $this->db->quote($this->getProtocol(), 'integer') . ', ' .
            'server = ' . $this->db->quote($this->getServer(), 'text') . ', ' .
            'port = ' . $this->db->quote($this->getPort(), 'integer') . ', ' .
            'auth_type = ' . $this->db->quote($this->getAuthType(), 'integer') . ', ' .
            'client_cert_path = ' . $this->db->quote($this->getClientCertPath(), 'text') . ', ' .
            'ca_cert_path = ' . $this->db->quote($this->getCACertPath(), 'text') . ', ' .
            'key_path = ' . $this->db->quote($this->getKeyPath(), 'text') . ', ' .
            'key_password = ' . $this->db->quote($this->getKeyPassword(), 'text') . ', ' .
            'cert_serial = ' . $this->db->quote($this->getCertSerialNumber(), 'text') . ', ' .
            'import_id = ' . $this->db->quote($this->getImportId(), 'integer') . ', ' .
            'global_role = ' . $this->db->quote($this->getGlobalRole(), 'integer') . ', ' .
            'econtent_rcp = ' . $this->db->quote($this->getEContentRecipientsAsString(), 'text') . ', ' .
            'user_rcp = ' . $this->db->quote($this->getUserRecipientsAsString(), 'text') . ', ' .
            'approval_rcp = ' . $this->db->quote($this->getApprovalRecipientsAsString(), 'text') . ', ' .
            'duration = ' . $this->db->quote($this->getDuration(), 'integer') . ', ' .
            'auth_user = ' . $this->db->quote($this->getAuthUser(), 'text') . ', ' .
            'auth_pass = ' . $this->db->quote($this->getAuthPass(), 'text') . ', ' .
            'auth_type = ' . $this->db->quote($this->getAuthType(), 'integer') . ' ' .
            'WHERE server_id = ' . $this->db->quote($this->getServerId(), 'integer')
        );
    }

validate()

ilECSSetting::validate

(

)

Validate settings.

Returns

string an string indicating a error or a empty string if no error occured

Definition at line 502 of file class.ilECSSetting.php.

                              : string
    {
        if (!$this->isEnabled()) {
            return '';
        }
 
        // Cert based authentication
        if ($this->getAuthType() === self::AUTH_CERTIFICATE) {
            if (!$this->getClientCertPath() || !$this->getCACertPath() || !$this->getKeyPath() || !$this->getKeyPassword()) {
                return self::ERROR_REQUIRED;
            }
            // Check import id
            if (!$this->fetchSerialID()) {
                return self::ERROR_EXTRACT_SERIAL;
            }
            if (!$this->fetchCertificateExpiration()) {
                return self::ERROR_CERT_EXPIRED;
            }
        }
        // Apache auth
        if ($this->getAuthType() === self::AUTH_APACHE) {
            if (!$this->getAuthUser() || !$this->getAuthPass()) {
                return self::ERROR_REQUIRED;
            }
        }
 
        // required fields
        if (!$this->getServer() || !$this->getPort() || !$this->getImportId()
            || !$this->getGlobalRole() || !$this->getDuration()) {
            return self::ERROR_REQUIRED;
        }
 
        if (!$this->checkImportId()) {
            return self::ERROR_INVALID_IMPORT_ID;
        }
        return '';
    }

References checkImportId(), ERROR_CERT_EXPIRED, ERROR_EXTRACT_SERIAL, ERROR_INVALID_IMPORT_ID, ERROR_REQUIRED, fetchCertificateExpiration(), fetchSerialID(), getAuthPass(), getAuthType(), getAuthUser(), getCACertPath(), getClientCertPath(), getDuration(), getGlobalRole(), getImportId(), getKeyPassword(), getKeyPath(), getPort(), getServer(), and isEnabled().

Here is the call graph for this function:

Field Documentation

$active

bool ilECSSetting::$active = false

private

Definition at line 45 of file class.ilECSSetting.php.

Referenced by isEnabled().

$approval_recipients

array ilECSSetting::$approval_recipients = []

private

Definition at line 65 of file class.ilECSSetting.php.

Referenced by getApprovalRecipients().

$auth_pass

string ilECSSetting::$auth_pass = ''

private

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

Referenced by getAuthPass().

$auth_type

int ilECSSetting::$auth_type = self::AUTH_CERTIFICATE

private

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

Referenced by getAuthType().

$auth_user

string ilECSSetting::$auth_user = ''

private

Definition at line 60 of file class.ilECSSetting.php.

Referenced by getAuthUser().

$ca_cert_path

string ilECSSetting::$ca_cert_path = ''

private

Definition at line 52 of file class.ilECSSetting.php.

Referenced by getCACertPath().

$cert_serial_number

string ilECSSetting::$cert_serial_number = ''

private

Definition at line 53 of file class.ilECSSetting.php.

Referenced by getCertSerialNumber().

$client_cert_path

string ilECSSetting::$client_cert_path = ''

private

Definition at line 51 of file class.ilECSSetting.php.

Referenced by getClientCertPath().

$db

ilDBInterface ilECSSetting::$db

private

Definition at line 67 of file class.ilECSSetting.php.

$duration

int ilECSSetting::$duration = 0

private

Definition at line 58 of file class.ilECSSetting.php.

$econtent_recipients

array ilECSSetting::$econtent_recipients = []

private

Definition at line 64 of file class.ilECSSetting.php.

Referenced by getEContentRecipients().

$global_role

int ilECSSetting::$global_role = 0

private

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

Referenced by getGlobalRole().

$import_id

int ilECSSetting::$import_id = 0

private

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

Referenced by getImportId().

$instances

array ilECSSetting::$instances = null

staticprotected

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

$key_password

string ilECSSetting::$key_password = ''

private

Definition at line 55 of file class.ilECSSetting.php.

Referenced by getKeyPassword().

$key_path

string ilECSSetting::$key_path = ''

private

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

Referenced by getKeyPath().

$log

ilLogger ilECSSetting::$log

private

Definition at line 68 of file class.ilECSSetting.php.

$objDataCache

ilObjectDataCache ilECSSetting::$objDataCache

private

Definition at line 69 of file class.ilECSSetting.php.

$port

int ilECSSetting::$port = 0

private

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

Referenced by getPort().

$protocol

int ilECSSetting::$protocol = self::PROTOCOL_HTTPS

private

Definition at line 49 of file class.ilECSSetting.php.

Referenced by getProtocol().

$server

string ilECSSetting::$server = ''

private

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

Referenced by getServer().

$server_id

int ilECSSetting::$server_id

private

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

Referenced by getServerId().

$title

string ilECSSetting::$title = ''

private

Definition at line 46 of file class.ilECSSetting.php.

Referenced by getTitle().

$tree

ilTree ilECSSetting::$tree

private

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

$user_recipients

array ilECSSetting::$user_recipients = []

private

Definition at line 63 of file class.ilECSSetting.php.

Referenced by getUserRecipients().

AUTH_APACHE

const ilECSSetting::AUTH_APACHE = 2

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

Referenced by ilECSSettingsGUI\initSettingsForm(), and ilECSConnector\prepareConnection().

AUTH_CERTIFICATE

const ilECSSetting::AUTH_CERTIFICATE = 1

Definition at line 33 of file class.ilECSSetting.php.

Referenced by ilECSSettingsGUI\initSettingsForm(), and ilECSConnector\prepareConnection().

DEFAULT_AUTH_MODE

const ilECSSetting::DEFAULT_AUTH_MODE = 'ldap'

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

Referenced by lookupAuthMode().

DEFAULT_DURATION

const ilECSSetting::DEFAULT_DURATION = 6

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

Referenced by getDuration().

ERROR_CERT_EXPIRED

const ilECSSetting::ERROR_CERT_EXPIRED = 'ecs_certificate_expired'

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

Referenced by validate().

ERROR_EXTRACT_SERIAL

const ilECSSetting::ERROR_EXTRACT_SERIAL = 'ecs_error_extract_serial'

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

Referenced by validate().

ERROR_INVALID_IMPORT_ID

const ilECSSetting::ERROR_INVALID_IMPORT_ID = 'ecs_check_import_id'

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

Referenced by validate().

ERROR_REQUIRED

const ilECSSetting::ERROR_REQUIRED = 'fill_out_all_required_fields'

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

Referenced by validate().

PROTOCOL_HTTP

const ilECSSetting::PROTOCOL_HTTP = 0

Definition at line 39 of file class.ilECSSetting.php.

Referenced by getServerURI().

PROTOCOL_HTTPS

const ilECSSetting::PROTOCOL_HTTPS = 1

Definition at line 40 of file class.ilECSSetting.php.

Referenced by getServerURI(), and ilECSSettingsGUI\initSettingsForm().

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSSetting.php