ilECSSetting Class Reference

Collaboration diagram for ilECSSetting:

Public Member Functions
	setTitle ($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 ($a_status)
	en/disable ecs functionality More...
	isEnabled ()
	is enabled More...
	setServer ($a_server)
	set server More...
	getServer ()
	get server More...
	getServerURI ()
	get complete server uri More...
	setProtocol ($a_prot)
	set protocol More...
	getProtocol ()
	get protocol More...
	setPort ($a_port)
	set port More...
	getPort ()
	get port More...
	setPollingTime ($a_time)
	set polling time More...
	getPollingTime ()
	get polling time More...
	getPollingTimeSeconds ()
	get polling time seconds (<60) More...
	getPollingTimeMinutes ()
	get polling time minutes More...
	setPollingTimeMS ($a_min, $a_sec)
	Set polling time. More...
	setClientCertPath ($a_path)
	set More...
	getClientCertPath ()
	get certificate path More...
	setCACertPath ($a_ca)
	set ca cert path More...
	getCACertPath ()
	get ca cert path More...
	getKeyPath ()
	get key path More...
	setKeyPath ($a_path)
	set key path More...
	getKeyPassword ()
	get key password More...
	setKeyPassword ($a_pass)
	set key password More...
	setImportId ($a_id)
	set import id Object of category, that store new remote courses More...
	getImportId ()
	get import id More...
	setCertSerialNumber ($a_cert_serial)
	set cert serial number More...
	getCertSerialNumber ()
	get cert serial number More...
	getGlobalRole ()
	get global role More...
	setGlobalRole ($a_role_id)
	set default global role More...
	setDuration ($a_duration)
	set Duration More...
	getDuration ()
	get duration More...
	getUserRecipients ()
	Get new user recipients. More...
	getUserRecipientsAsString ()
	Get new user recipients. More...
	setUserRecipients ($a_logins)
	set user recipients More...
	getEContentRecipients ()
	get Econtent recipients More...
	getEContentRecipientsAsString ()
	get EContent recipients as string More...
	setEContentRecipients ($a_logins)
	set EContent recipients More...
	getApprovalRecipients ()
	get approval recipients More...
	getApprovalRecipientsAsString ()
	get approval recipients as string More...
	setApprovalRecipients ($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	_getInstance ()
	singleton getInstance More...
static	getInstanceByServerId ($a_server_id)
	Get singleton instance per server. More...
static	lookupAuthMode ()
	Lookup auth mode. 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	$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
	$server_id = 0
	$active = false
	$title = ''
	$auth_type = self::AUTH_CERTIFICATE
	$server
	$protocol
	$port
	$client_cert_path
	$ca_cert_path
	$key_path
	$key_password
	$polling
	$import_id
	$cert_serial
	$global_role
	$duration
	$auth_user = ''
	$auth_pass = ''
	$user_recipients = array()
	$econtent_recipients = array()
	$approval_recipients = array()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilECSSetting::__construct (   $a_server_id = 0 )

private

Singleton contructor.

private

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

References read().

    {
        $this->server_id = $a_server_id;
        $this->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 968 of file class.ilECSSetting.php.

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

    {
        $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('');
    }

Here is the call graph for this function:

_getInstance()

static ilECSSetting::_getInstance ( )

static

singleton getInstance

public

Deprecated:

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

References $GLOBALS, and ilLogLevel\WARNING.

    {
        $GLOBALS['DIC']->logger()->wsrv()->warning('Using deprecated call');
        $GLOBALS['DIC']->logger()->wsrv()->logStack(ilLogLevel::WARNING);
        return self::getInstanceByServerId(null);
    }

checkImportId()

ilECSSetting::checkImportId

(

)

check import id

public

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

References getImportId().

Referenced by validate().

    {
        global $ilObjDataCache,$tree;
        
        if (!$this->getImportId()) {
            return false;
        }
        if ($ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($this->getImportId())) != 'cat') {
            return false;
        }
        if ($tree->isDeleted($this->getImportId())) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilECSSetting::delete

(

)

Delete.

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

References $ilDB, ilECSCommunityCache\deleteByServerId(), ilECSDataMappingSetting\deleteByServerId(), ilECSNodeMappingAssignment\deleteByServerId(), ilECSParticipantSetting\deleteByServerId(), ilECSExport\deleteByServerId(), ilECSCmsData\deleteByServerId(), ilECSEventQueueReader\deleteByServerId(), getServerId(), and ilECSImport\resetServerId().

    {
        global $ilDB;
        
        // --- cascading delete

        include_once 'Services/WebServices/ECS/classes/Tree/class.ilECSCmsData.php';
        ilECSCmsData::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSCommunityCache.php';
        ilECSCommunityCache::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSDataMappingSetting.php';
        ilECSDataMappingSetting::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSEventQueueReader.php';
        ilECSEventQueueReader::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/Mapping/class.ilECSNodeMappingAssignment.php';
        ilECSNodeMappingAssignment::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php';
        ilECSParticipantSetting::deleteByServerId($this->getServerId());
        
        include_once 'Services/WebServices/ECS/classes/class.ilECSExport.php';
        ilECSExport::deleteByServerId($this->getServerId());
                
        // resetting server id to flag items in imported list
        include_once 'Services/WebServices/ECS/classes/class.ilECSImport.php';
        ilECSImport::resetServerId($this->getServerId());
                        
        $ilDB->manipulate(
            'DELETE FROM ecs_server ' .
            'WHERE server_id = ' . $ilDB->quote($this->getServerId(), 'integer')
        );
        
        $this->server_id = null;
        return true;
    }

Here is the call graph for this function:

fetchCertificateExpiration()

ilECSSetting::fetchCertificateExpiration

(

)

Fetch validity (expired date)

Returns

bool

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

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

Referenced by validate().

    {
        if ($this->getAuthType() != self::AUTH_CERTIFICATE) {
            return null;
        }

        if (function_exists('openssl_x509_parse') and $cert = openssl_x509_parse('file://' . $this->getClientCertPath())) {
            if (isset($cert['validTo_time_t']) and $cert['validTo_time_t']) {
                $dt = new ilDateTime($cert['validTo_time_t'], IL_CAL_UNIX);
                
                $GLOBALS['DIC']->logger()->wsrv()->debug('Certificate expires at: ' . ilDatePresentation::formatDate($dt));
                return $dt;
            }
        }
        return null;
    }

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.

private

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

References $GLOBALS, file, getClientCertPath(), and setCertSerialNumber().

Referenced by validate().

    {
        if (function_exists('openssl_x509_parse') and $cert = openssl_x509_parse('file://' . $this->getClientCertPath())) {
            if (isset($cert['serialNumber']) and $cert['serialNumber']) {
                $this->setCertSerialNumber($cert['serialNumber']);
                $GLOBALS['DIC']->logger()->wsrv()->debug('Searial number is: ' . $cert['serialNumber']);
                return true;
            }
        }
        
        if (!file_exists($this->getClientCertPath()) or !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 = (int) trim($serial_line[1]);
                break;
            }
        }
        if ($found) {
            $this->setCertSerialNumber($serial);
            return true;
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getApprovalRecipients()

ilECSSetting::getApprovalRecipients

(

)

get approval recipients

public

Returns

bool

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

Referenced by ilECSObjectSettings\sendNewContentNotification().

    {
        return explode(',', $this->approval_recipients);
    }

Here is the caller graph for this function:

getApprovalRecipientsAsString()

ilECSSetting::getApprovalRecipientsAsString

(

)

get approval recipients as string

public

Parameters

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

Referenced by ilECSObjectSettings\sendNewContentNotification().

    {
        return $this->approval_recipients ? $this->approval_recipients : '';
    }

Here is the caller graph for this function:

getAuthPass()

ilECSSetting::getAuthPass

(

)

Get auth password.

Returns

string

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

References $auth_pass.

Referenced by validate().

    {
        return $this->auth_pass;
    }

Here is the caller graph for this function:

getAuthType()

ilECSSetting::getAuthType

(

)

Get auth type.

Returns

int

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

References $auth_type.

Referenced by fetchCertificateExpiration(), and validate().

    {
        return $this->auth_type;
    }

Here is the caller graph for this function:

getAuthUser()

ilECSSetting::getAuthUser

(

)

Get apache auth user.

Returns

string

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

References $auth_user.

Referenced by validate().

    {
        return $this->auth_user;
    }

Here is the caller graph for this function:

getCACertPath()

ilECSSetting::getCACertPath

(

)

get ca cert path

public

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

References $ca_cert_path.

Referenced by validate().

    {
        return $this->ca_cert_path;
    }

Here is the caller graph for this function:

getCertSerialNumber()

ilECSSetting::getCertSerialNumber

(

)

get cert serial number

public

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

    {
        return $this->cert_serial_number;
    }

getClientCertPath()

ilECSSetting::getClientCertPath

(

)

get certificate path

public

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

References $client_cert_path.

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

    {
        return $this->client_cert_path;
    }

Here is the caller graph for this function:

getDuration()

ilECSSetting::getDuration

(

)

get duration

public

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

Referenced by ilECSAppEventListener\extendAccount(), and validate().

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

Here is the caller graph for this function:

getEContentRecipients()

ilECSSetting::getEContentRecipients

(

)

get Econtent recipients

public

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

    {
        return explode(',', $this->econtent_recipients);
    }

getEContentRecipientsAsString()

ilECSSetting::getEContentRecipientsAsString

(

)

get EContent recipients as string

public

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

    {
        return $this->econtent_recipients ? $this->econtent_recipients : '';
    }

getGlobalRole()

ilECSSetting::getGlobalRole

(

)

get global role

public

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

References $global_role.

Referenced by ilECSObjectSettings\handlePermissionUpdate(), and validate().

    {
        return $this->global_role;
    }

Here is the caller graph for this function:

getImportId()

ilECSSetting::getImportId

(

)

get import id

public

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

References $import_id.

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

    {
        return $this->import_id;
    }

Here is the caller graph for this function:

getInstanceByServerId()

static ilECSSetting::getInstanceByServerId (   $a_server_id )

static

Get singleton instance per server.

Parameters

int

$a_server_id

Returns

ilECSSetting

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

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

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

Here is the caller graph for this function:

getKeyPassword()

ilECSSetting::getKeyPassword

(

)

get key password

public

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

References $key_password.

Referenced by validate().

    {
        return $this->key_password;
    }

Here is the caller graph for this function:

getKeyPath()

ilECSSetting::getKeyPath

(

)

get key path

public

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

References $key_path.

Referenced by validate().

    {
        return $this->key_path;
    }

Here is the caller graph for this function:

getPollingTime()

ilECSSetting::getPollingTime

(

)

get polling time

public

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

References $polling.

Referenced by validate().

    {
        return $this->polling;
    }

Here is the caller graph for this function:

getPollingTimeMinutes()

ilECSSetting::getPollingTimeMinutes

(

)

get polling time minutes

public

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

    {
        return (int) ($this->polling / 60);
    }

getPollingTimeSeconds()

ilECSSetting::getPollingTimeSeconds

(

)

get polling time seconds (<60)

public

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

    {
        return (int) ($this->polling % 60);
    }

getPort()

ilECSSetting::getPort

(

)

get port

public

Parameters

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

References $port.

Referenced by getServerURI(), and validate().

    {
        return $this->port;
    }

Here is the caller graph for this function:

getProtocol()

ilECSSetting::getProtocol

(

)

get protocol

public

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

References $protocol.

Referenced by getServerURI().

    {
        return $this->protocol;
    }

Here is the caller graph for this function:

getServer()

ilECSSetting::getServer

(

)

get server

public

Parameters

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

References $server.

Referenced by getServerURI(), and validate().

    {
        return $this->server;
    }

Here is the caller graph for this function:

getServerId()

ilECSSetting::getServerId

(

)

Get current server id.

Returns

int

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

References $server_id.

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

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

Here is the caller graph for this function:

getServerURI()

ilECSSetting::getServerURI

(

)

get complete server uri

public

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

References $counter, $key, array, getPort(), getProtocol(), and getServer().

    {
        switch ($this->getProtocol()) {
            case self::PROTOCOL_HTTP:
                $uri = 'http://';
                break;
                
            case self::PROTOCOL_HTTPS:
                $uri = 'https://';
                break;
        }

        if (stristr($this->getServer(), '/')) {
            $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;
    }

Here is the call graph for this function:

getTitle()

ilECSSetting::getTitle

(

)

Get title.

Returns

string title

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

References $title.

Referenced by __clone().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getUserRecipients()

ilECSSetting::getUserRecipients

(

)

Get new user recipients.

public

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

Referenced by ilECSAppEventListener\_sendNotification().

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

Here is the caller graph for this function:

getUserRecipientsAsString()

ilECSSetting::getUserRecipientsAsString

(

)

Get new user recipients.

public

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

Referenced by ilECSAppEventListener\_sendNotification().

    {
        return $this->user_recipients ? $this->user_recipients : '';
    }

Here is the caller graph for this function:

isEnabled()

ilECSSetting::isEnabled

(

)

is enabled

public

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

References $active.

Referenced by validate().

    {
        return $this->active;
    }

Here is the caller graph for this function:

lookupAuthMode()

static ilECSSetting::lookupAuthMode ( )

static

Lookup auth mode.

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

    {
        return self::DEFAULT_AUTH_MODE;
    }

read()

ilECSSetting::read ( )

private

Read settings.

private

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

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

Referenced by __construct().

    {
        global $ilDB;
        
        if (!$this->getServerId()) {
            return false;
        }

        $query = 'SELECT * FROM ecs_server ' .
            'WHERE server_id = ' . $ilDB->quote($this->getServerId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $this->setServer($row['server']);
            $this->setTitle($row['title']);
            $this->setProtocol($row['protocol']);
            $this->setPort($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->setPollingTime($row['polling_time']);
            $this->setImportId($row['import_id']);
            $this->setEnabledStatus((int) $row['active']);
            $this->setCertSerialNumber($row['cert_serial']);
            $this->setGlobalRole($row['global_role']);
            $this->econtent_recipients = $row['econtent_rcp'];
            $this->approval_recipients = $row['approval_rcp'];
            $this->user_recipients = $row['user_rcp'];
            $this->setDuration($row['duration']);
            $this->setAuthUser($row['auth_user']);
            $this->setAuthPass($row['auth_pass']);
            $this->setAuthType($row['auth_type']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSSetting::save

(

)

save settings

public

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

References $ilDB.

    {
        global $ilDB;

        $this->server_id = $ilDB->nextId('ecs_server');
        $ilDB->manipulate(
            $q = '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,polling_time,import_id,global_role,econtent_rcp,user_rcp,approval_rcp,duration,auth_user,auth_pass) ' .
            'VALUES (' .
            $ilDB->quote($this->getServerId(), 'integer') . ', ' .
            $ilDB->quote((int) $this->isEnabled(), 'integer') . ', ' .
            $ilDB->quote($this->getTitle(), 'text') . ', ' .
            $ilDB->quote((int) $this->getProtocol(), 'integer') . ', ' .
            $ilDB->quote($this->getServer(), 'text') . ', ' .
            $ilDB->quote($this->getPort(), 'integer') . ', ' .
            $ilDB->quote($this->getAuthType(), 'integer') . ', ' .
            $ilDB->quote($this->getClientCertPath(), 'text') . ', ' .
            $ilDB->quote($this->getCACertPath(), 'text') . ', ' .
            $ilDB->quote($this->getKeyPath(), 'text') . ', ' .
            $ilDB->quote($this->getKeyPassword(), 'text') . ', ' .
            $ilDB->quote($this->getCertSerialNumber(), 'text') . ', ' .
            $ilDB->quote($this->getPollingTime(), 'integer') . ', ' .
            $ilDB->quote($this->getImportId(), 'integer') . ', ' .
            $ilDB->quote($this->getGlobalRole(), 'integer') . ', ' .
            $ilDB->quote($this->getEContentRecipientsAsString(), 'text') . ', ' .
            $ilDB->quote($this->getUserRecipientsAsString(), 'text') . ', ' .
            $ilDB->quote($this->getApprovalRecipientsAsString(), 'text') . ', ' .
            $ilDB->quote($this->getDuration(), 'integer') . ', ' .
            $ilDB->quote($this->getAuthUser(), 'text') . ', ' .
            $ilDB->quote($this->getAuthPass(), 'text') . ' ' .
            ')'
        );
    }

setApprovalRecipients()

ilECSSetting::setApprovalRecipients

(

$a_rcp

)

set approval recipients

public

Parameters

string

recipients

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

    {
        $this->approval_recipients = $a_rcp;
    }

setAuthPass()

ilECSSetting::setAuthPass

(

$a_pass

)

Set Apache auth password.

Parameters

string

$a_pass

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

Referenced by __clone(), and read().

    {
        $this->auth_pass = $a_pass;
    }

Here is the caller graph for this function:

setAuthType()

ilECSSetting::setAuthType

(

$a_auth_type

)

Set auth type.

Parameters

int

$a_auth_type

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

Referenced by __clone(), and read().

    {
        $this->auth_type = $a_auth_type;
    }

Here is the caller graph for this function:

setAuthUser()

ilECSSetting::setAuthUser

(

$a_user

)

Set apache auth user.

Parameters

string

$a_user

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

Referenced by __clone(), and read().

    {
        $this->auth_user = $a_user;
    }

Here is the caller graph for this function:

setCACertPath()

ilECSSetting::setCACertPath

(

$a_ca

)

set ca cert path

public

Parameters

string

ca cert path

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

Referenced by __clone(), and read().

    {
        $this->ca_cert_path = $a_ca;
    }

Here is the caller graph for this function:

setCertSerialNumber()

ilECSSetting::setCertSerialNumber

(

$a_cert_serial

)

set cert serial number

public

Parameters

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

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

    {
        $this->cert_serial_number = $a_cert_serial;
    }

Here is the caller graph for this function:

setClientCertPath()

ilECSSetting::setClientCertPath

(

$a_path

)

set

public

Parameters

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

Referenced by __clone(), and read().

    {
        $this->client_cert_path = $a_path;
    }

Here is the caller graph for this function:

setDuration()

ilECSSetting::setDuration

(

$a_duration

)

set Duration

public

Parameters

int

duration

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

Referenced by read().

    {
        $this->duration = $a_duration;
    }

Here is the caller graph for this function:

setEContentRecipients()

ilECSSetting::setEContentRecipients

(

$a_logins

)

set EContent recipients

public

Parameters

array

of user obj_ids

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

    {
        $this->econtent_recipients = $a_logins;
    }

setEnabledStatus()

ilECSSetting::setEnabledStatus

(

$a_status

)

en/disable ecs functionality

public

Parameters

bool

status

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

Referenced by __clone(), and read().

    {
        $this->active = $a_status;
    }

Here is the caller graph for this function:

setGlobalRole()

ilECSSetting::setGlobalRole

(

$a_role_id

)

set default global role

public

Parameters

int

role_id

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

Referenced by read().

    {
        $this->global_role = $a_role_id;
    }

Here is the caller graph for this function:

setImportId()

ilECSSetting::setImportId

(

$a_id

)

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

public

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

Referenced by read().

    {
        $this->import_id = $a_id;
    }

Here is the caller graph for this function:

setKeyPassword()

ilECSSetting::setKeyPassword

(

$a_pass

)

set key password

public

Parameters

string

key password

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

Referenced by __clone(), and read().

    {
        $this->key_password = $a_pass;
    }

Here is the caller graph for this function:

setKeyPath()

ilECSSetting::setKeyPath

(

$a_path

)

set key path

public

Parameters

string

key path

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

Referenced by __clone(), and read().

    {
        $this->key_path = $a_path;
    }

Here is the caller graph for this function:

setPollingTime()

ilECSSetting::setPollingTime

(

$a_time

)

set polling time

public

Parameters

int	polling time

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

Referenced by read(), and setPollingTimeMS().

    {
        $this->polling = $a_time;
    }

Here is the caller graph for this function:

setPollingTimeMS()

ilECSSetting::setPollingTimeMS	(		$a_min,
			$a_sec
	)

Set polling time.

public

Parameters

int	minutes
int	seconds

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

References setPollingTime().

    {
        $this->setPollingTime(60 * $a_min + $a_sec);
    }

Here is the call graph for this function:

setPort()

ilECSSetting::setPort

(

$a_port

)

set port

public

Parameters

int

port

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

Referenced by __clone(), and read().

    {
        $this->port = $a_port;
    }

Here is the caller graph for this function:

setProtocol()

ilECSSetting::setProtocol

(

$a_prot

)

set protocol

public

Parameters

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

Referenced by __clone(), and read().

    {
        $this->protocol = $a_prot;
    }

Here is the caller graph for this function:

setServer()

ilECSSetting::setServer

(

$a_server

)

set server

public

Parameters

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

Referenced by __clone(), and read().

    {
        $this->server = $a_server;
    }

Here is the caller graph for this function:

setTitle()

ilECSSetting::setTitle

(

$a_title

)

Set title.

Parameters

string

$a_title

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

Referenced by __clone(), and read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setUserRecipients()

ilECSSetting::setUserRecipients

(

$a_logins

)

set user recipients

public

Parameters

array

of recipients (array of user login names)

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

    {
        $this->user_recipients = $a_logins;
    }

update()

ilECSSetting::update

(

)

Update setting.

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

References $ilDB.

    {
        global $ilDB;

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

validate()

ilECSSetting::validate

(

)

Validate settings.

public

Parameters

void

Returns

bool

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

References AUTH_APACHE, checkImportId(), fetchCertificateExpiration(), fetchSerialID(), getAuthPass(), getAuthType(), getAuthUser(), getCACertPath(), getClientCertPath(), getDuration(), getGlobalRole(), getImportId(), getKeyPassword(), getKeyPath(), getPollingTime(), getPort(), getServer(), and isEnabled().

    {
        if (!$this->isEnabled()) {
            return '';
        }

        // Cert based authentication
        if ($this->getAuthType() == self::AUTH_CERTIFICATE) {
            if (!$this->getClientCertPath() or !$this->getCACertPath() or !$this->getKeyPath() or !$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() or !$this->getAuthPass()) {
                return self::ERROR_REQUIRED;
            }
        }

        // required fields
        if (!$this->getServer() or !$this->getPort() or !$this->getPollingTime() or !$this->getImportId()
            or !$this->getGlobalRole() or !$this->getDuration()) {
            return self::ERROR_REQUIRED;
        }
        
        if (!$this->checkImportId()) {
            return self::ERROR_INVALID_IMPORT_ID;
        }
        return '';
    }

Here is the call graph for this function:

Field Documentation

$active

ilECSSetting::$active = false

private

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

Referenced by isEnabled().

$approval_recipients

ilECSSetting::$approval_recipients = array()

private

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

$auth_pass

ilECSSetting::$auth_pass = ''

private

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

Referenced by getAuthPass().

$auth_type

ilECSSetting::$auth_type = self::AUTH_CERTIFICATE

private

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

Referenced by getAuthType().

$auth_user

ilECSSetting::$auth_user = ''

private

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

Referenced by getAuthUser().

$ca_cert_path

ilECSSetting::$ca_cert_path

private

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

Referenced by getCACertPath().

$cert_serial

ilECSSetting::$cert_serial

private

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

$client_cert_path

ilECSSetting::$client_cert_path

private

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

Referenced by getClientCertPath().

$duration

ilECSSetting::$duration

private

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

$econtent_recipients

ilECSSetting::$econtent_recipients = array()

private

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

$global_role

ilECSSetting::$global_role

private

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

Referenced by getGlobalRole().

$import_id

ilECSSetting::$import_id

private

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

Referenced by getImportId().

$instances

ilECSSetting::$instances = null

staticprotected

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

$key_password

ilECSSetting::$key_password

private

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

Referenced by getKeyPassword().

$key_path

ilECSSetting::$key_path

private

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

Referenced by getKeyPath().

$polling

ilECSSetting::$polling

private

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

Referenced by getPollingTime().

$port

ilECSSetting::$port

private

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

Referenced by getPort().

$protocol

ilECSSetting::$protocol

private

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

Referenced by getProtocol().

$server

ilECSSetting::$server

private

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

Referenced by getServer().

$server_id

ilECSSetting::$server_id = 0

private

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

Referenced by getServerId().

$title

ilECSSetting::$title = ''

private

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

Referenced by getTitle().

$user_recipients

ilECSSetting::$user_recipients = array()

private

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

AUTH_APACHE

const ilECSSetting::AUTH_APACHE = 2

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

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

AUTH_CERTIFICATE

const ilECSSetting::AUTH_CERTIFICATE = 1

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

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

DEFAULT_AUTH_MODE

const ilECSSetting::DEFAULT_AUTH_MODE = 'ldap'

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

DEFAULT_DURATION

const ilECSSetting::DEFAULT_DURATION = 6

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

ERROR_CERT_EXPIRED

const ilECSSetting::ERROR_CERT_EXPIRED = 'ecs_certificate_expired'

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

ERROR_EXTRACT_SERIAL

const ilECSSetting::ERROR_EXTRACT_SERIAL = 'ecs_error_extract_serial'

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

ERROR_INVALID_IMPORT_ID

const ilECSSetting::ERROR_INVALID_IMPORT_ID = 'ecs_check_import_id'

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

ERROR_REQUIRED

const ilECSSetting::ERROR_REQUIRED = 'fill_out_all_required_fields'

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

PROTOCOL_HTTP

const ilECSSetting::PROTOCOL_HTTP = 0

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

PROTOCOL_HTTPS

const ilECSSetting::PROTOCOL_HTTPS = 1

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

Referenced by ilECSSettingsGUI\initSettingsForm().

---

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

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