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...
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	$instances = null
static	$configured

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.

@access private

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

    {
        $this->server_id = $a_server_id;
        $this->read();
    }

References 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 1000 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:

_getInstance()

static ilECSSetting::_getInstance ( )

static

singleton getInstance

@access public

Deprecated:

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

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

References $GLOBALS, getInstanceByServerId(), and ilLogLevel\WARNING.

Here is the call graph for this function:

checkImportId()

ilECSSetting::checkImportId

(

)

check import id

@access public

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

    {
        global $DIC;
 
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $tree = $DIC['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;
    }

References $DIC, $tree, and 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 853 of file class.ilECSSetting.php.

    {
        global $DIC;
 
        $ilDB = $DIC['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;
    }

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

Here is the call graph for this function:

ecsConfigured()

static ilECSSetting::ecsConfigured ( )

static

Checks if an ecs server is configured.

Returns

boolean

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

    {
        if (self::$configured === null) {
            global $DIC;
            $ilDB = $DIC->database();
 
            $query = "SELECT count(*) count FROM ecs_server";
            $ret = $ilDB->query($query);
            $c = $ret->fetchObject()->count;
 
            self::$configured = $c > 0;
        }
        return self::$configured;
    }

References $c, $configured, $DIC, $ilDB, $query, and $ret.

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

Here is the caller graph for this function:

fetchCertificateExpiration()

ilECSSetting::fetchCertificateExpiration

(

)

Fetch validity (expired date)

Returns

bool

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

    {
        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;
    }

References $GLOBALS, 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.

@access private

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

    {
        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;
        }
    }

References $GLOBALS, 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

@access public

Returns

bool

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

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

Referenced by ilECSObjectSettings\sendNewContentNotification().

Here is the caller graph for this function:

getApprovalRecipientsAsString()

ilECSSetting::getApprovalRecipientsAsString

(

)

get approval recipients as string

@access public

Parameters

return

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

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

Referenced by ilECSObjectSettings\sendNewContentNotification().

Here is the caller graph for this function:

getAuthPass()

ilECSSetting::getAuthPass

(

)

Get auth password.

Returns

string

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

    {
        return $this->auth_pass;
    }

References $auth_pass.

Referenced by validate().

Here is the caller graph for this function:

getAuthType()

ilECSSetting::getAuthType

(

)

Get auth type.

Returns

int

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

    {
        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.

Returns

string

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

    {
        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

@access public

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

    {
        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

@access public

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

    {
        return $this->cert_serial_number;
    }

getClientCertPath()

ilECSSetting::getClientCertPath

(

)

get certificate path

@access public

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

    {
        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

@access public

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

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

References DEFAULT_DURATION.

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

Here is the caller graph for this function:

getEContentRecipients()

ilECSSetting::getEContentRecipients

(

)

get Econtent recipients

@access public

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

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

getEContentRecipientsAsString()

ilECSSetting::getEContentRecipientsAsString

(

)

get EContent recipients as string

@access public

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

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

getGlobalRole()

ilECSSetting::getGlobalRole

(

)

get global role

@access public

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

    {
        return $this->global_role;
    }

References $global_role.

Referenced by validate().

Here is the caller graph for this function:

getImportId()

ilECSSetting::getImportId

(

)

get import id

@access public

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

    {
        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 (   $a_server_id )

static

Get singleton instance per server.

Parameters

int

$a_server_id

Returns

ilECSSetting

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

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

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

Here is the caller graph for this function:

getKeyPassword()

ilECSSetting::getKeyPassword

(

)

get key password

@access public

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

    {
        return $this->key_password;
    }

References $key_password.

Referenced by validate().

Here is the caller graph for this function:

getKeyPath()

ilECSSetting::getKeyPath

(

)

get key path

@access public

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

    {
        return $this->key_path;
    }

References $key_path.

Referenced by validate().

Here is the caller graph for this function:

getPollingTime()

ilECSSetting::getPollingTime

(

)

get polling time

@access public

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

    {
        return $this->polling;
    }

References $polling.

getPollingTimeMinutes()

ilECSSetting::getPollingTimeMinutes

(

)

get polling time minutes

@access public

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

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

getPollingTimeSeconds()

ilECSSetting::getPollingTimeSeconds

(

)

get polling time seconds (<60)

@access public

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

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

getPort()

ilECSSetting::getPort

(

)

get port

@access public

Parameters

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

    {
        return $this->port;
    }

References $port.

Referenced by getServerURI(), and validate().

Here is the caller graph for this function:

getProtocol()

ilECSSetting::getProtocol

(

)

get protocol

@access public

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

    {
        return $this->protocol;
    }

References $protocol.

Referenced by getServerURI().

Here is the caller graph for this function:

getServer()

ilECSSetting::getServer

(

)

get server

@access public

Parameters

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

    {
        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.

Returns

int

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

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

References $server_id.

Referenced by ilECSCommunityTableGUI\__construct(), ilECSObjectSettings\addMetadataToJson(), ilRemoteObjectBase\createFromECSEContent(), delete(), ilECSObjectSettings\doUpdate(), ilRemoteObjectBase\handleDelete(), ilECSObjectSettings\handleSettingsForServer(), ilRemoteObjectBase\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

@access public

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

    {
        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;
    }

References $key, 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 159 of file class.ilECSSetting.php.

    {
        return $this->title;
    }

References $title.

Referenced by __clone().

Here is the caller graph for this function:

getUserRecipients()

ilECSSetting::getUserRecipients

(

)

Get new user recipients.

@access public

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

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

getUserRecipientsAsString()

ilECSSetting::getUserRecipientsAsString

(

)

Get new user recipients.

@access public

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

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

isEnabled()

ilECSSetting::isEnabled

(

)

is enabled

@access public

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

    {
        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 121 of file class.ilECSSetting.php.

    {
        return self::DEFAULT_AUTH_MODE;
    }

References DEFAULT_AUTH_MODE.

read()

ilECSSetting::read ( )

private

Read settings.

@access private

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

    {
        global $DIC;
 
        $ilDB = $DIC['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']);
        }
    }

References $DIC, $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().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilECSSetting::save

(

)

save settings

@access public

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

    {
        global $DIC;
 
        $ilDB = $DIC['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') . ' ' .
            ')'
        );
    }

References $DIC, and $ilDB.

setApprovalRecipients()

ilECSSetting::setApprovalRecipients

(

$a_rcp

)

set approval recipients

@access public

Parameters

string

recipients

Definition at line 695 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 204 of file class.ilECSSetting.php.

    {
        $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.

Parameters

int

$a_auth_type

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

    {
        $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.

Parameters

string

$a_user

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

    {
        $this->auth_user = $a_user;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setCACertPath()

ilECSSetting::setCACertPath

(

$a_ca

)

set ca cert path

@access public

Parameters

string

ca cert path

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

    {
        $this->ca_cert_path = $a_ca;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setCertSerialNumber()

ilECSSetting::setCertSerialNumber

(

$a_cert_serial

)

set cert serial number

@access public

Parameters

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

    {
        $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

)

set

@access public

Parameters

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

    {
        $this->client_cert_path = $a_path;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setDuration()

ilECSSetting::setDuration

(

$a_duration

)

set Duration

@access public

Parameters

int

duration

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

    {
        $this->duration = $a_duration;
    }

Referenced by read().

Here is the caller graph for this function:

setEContentRecipients()

ilECSSetting::setEContentRecipients

(

$a_logins

)

set EContent recipients

@access public

Parameters

array

of user obj_ids

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

    {
        $this->econtent_recipients = $a_logins;
    }

setEnabledStatus()

ilECSSetting::setEnabledStatus

(

$a_status

)

en/disable ecs functionality

@access public

Parameters

bool

status

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

    {
        $this->active = $a_status;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setGlobalRole()

ilECSSetting::setGlobalRole

(

$a_role_id

)

set default global role

@access public

Parameters

int

role_id

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

    {
        $this->global_role = $a_role_id;
    }

Referenced by read().

Here is the caller graph for this function:

setImportId()

ilECSSetting::setImportId

(

$a_id

)

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

@access public

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

    {
        $this->import_id = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

setKeyPassword()

ilECSSetting::setKeyPassword

(

$a_pass

)

set key password

@access public

Parameters

string

key password

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

    {
        $this->key_password = $a_pass;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setKeyPath()

ilECSSetting::setKeyPath

(

$a_path

)

set key path

@access public

Parameters

string

key path

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

    {
        $this->key_path = $a_path;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setPollingTime()

ilECSSetting::setPollingTime

(

$a_time

)

set polling time

@access public

Parameters

int	polling time

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

    {
        $this->polling = $a_time;
    }

Referenced by read(), and setPollingTimeMS().

Here is the caller graph for this function:

setPollingTimeMS()

ilECSSetting::setPollingTimeMS	(		$a_min,
			$a_sec
	)

Set polling time.

@access public

Parameters

int	minutes
int	seconds

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

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

References setPollingTime().

Here is the call graph for this function:

setPort()

ilECSSetting::setPort

(

$a_port

)

set port

@access public

Parameters

int

port

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

    {
        $this->port = $a_port;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setProtocol()

ilECSSetting::setProtocol

(

$a_prot

)

set protocol

@access public

Parameters

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

    {
        $this->protocol = $a_prot;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setServer()

ilECSSetting::setServer

(

$a_server

)

set server

@access public

Parameters

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

    {
        $this->server = $a_server;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setTitle()

ilECSSetting::setTitle

(

$a_title

)

Set title.

Parameters

string

$a_title

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

    {
        $this->title = $a_title;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

setUserRecipients()

ilECSSetting::setUserRecipients

(

$a_logins

)

set user recipients

@access public

Parameters

array

of recipients (array of user login names)

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

    {
        $this->user_recipients = $a_logins;
    }

update()

ilECSSetting::update

(

)

Update setting.

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

    {
        global $DIC;
 
        $ilDB = $DIC['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')
        );
    }

References $DIC, and $ilDB.

validate()

ilECSSetting::validate

(

)

Validate settings.

@access public

Parameters

void

Returns

bool

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

    {
        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->getImportId()
            or !$this->getGlobalRole() or !$this->getDuration()) {
            return self::ERROR_REQUIRED;
        }
        
        if (!$this->checkImportId()) {
            return self::ERROR_INVALID_IMPORT_ID;
        }
        return '';
    }

References AUTH_APACHE, 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

ilECSSetting::$active = false

private

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

Referenced by isEnabled().

$approval_recipients

ilECSSetting::$approval_recipients = array()

private

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

$auth_pass

ilECSSetting::$auth_pass = ''

private

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

Referenced by getAuthPass().

$auth_type

ilECSSetting::$auth_type = self::AUTH_CERTIFICATE

private

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

Referenced by getAuthType().

$auth_user

ilECSSetting::$auth_user = ''

private

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

Referenced by getAuthUser().

$ca_cert_path

ilECSSetting::$ca_cert_path

private

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

Referenced by getCACertPath().

$cert_serial

ilECSSetting::$cert_serial

private

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

$client_cert_path

ilECSSetting::$client_cert_path

private

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

Referenced by getClientCertPath().

$configured

ilECSSetting::$configured

staticprotected

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

Referenced by ecsConfigured().

$duration

ilECSSetting::$duration

private

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

$econtent_recipients

ilECSSetting::$econtent_recipients = array()

private

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

$global_role

ilECSSetting::$global_role

private

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

Referenced by getGlobalRole().

$import_id

ilECSSetting::$import_id

private

Definition at line 67 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 65 of file class.ilECSSetting.php.

Referenced by getKeyPassword().

$key_path

ilECSSetting::$key_path

private

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

Referenced by getKeyPath().

$polling

ilECSSetting::$polling

private

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

Referenced by getPollingTime().

$port

ilECSSetting::$port

private

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

Referenced by getPort().

$protocol

ilECSSetting::$protocol

private

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

Referenced by getProtocol().

$server

ilECSSetting::$server

private

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

Referenced by getServer().

$server_id

ilECSSetting::$server_id = 0

private

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

Referenced by getServerId().

$title

ilECSSetting::$title = ''

private

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

Referenced by getTitle().

$user_recipients

ilECSSetting::$user_recipients = array()

private

Definition at line 75 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.

Referenced by lookupAuthMode().

DEFAULT_DURATION

const ilECSSetting::DEFAULT_DURATION = 6

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

Referenced by getDuration().

ERROR_CERT_EXPIRED

const ilECSSetting::ERROR_CERT_EXPIRED = 'ecs_certificate_expired'

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

Referenced by validate().

ERROR_EXTRACT_SERIAL

const ilECSSetting::ERROR_EXTRACT_SERIAL = 'ecs_error_extract_serial'

Definition at line 37 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 39 of file class.ilECSSetting.php.

Referenced by validate().

ERROR_REQUIRED

const ilECSSetting::ERROR_REQUIRED = 'fill_out_all_required_fields'

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

Referenced by validate().

PROTOCOL_HTTP

const ilECSSetting::PROTOCOL_HTTP = 0

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

Referenced by getServerURI().

PROTOCOL_HTTPS

const ilECSSetting::PROTOCOL_HTTPS = 1

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

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

---

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

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