Collaboration diagram for ilECSParticipantSettings:

Public Member Functions
	getServerId ()
	Get server id. More...

	read ()
	Read stored entry. More...

	isImportAllowed (array $a_mids)
	Check if import is allowed for scecific mid. More...

	getEnabledParticipants ()
	get number of participants that are enabled More...

	isEnabled ($a_mid)
	is partivcipant enabled More...

	setEnabledParticipants ($a_parts)
	set enabled participants by community More...

Static Public Member Functions
static	_getInstance ()
	get instance More...

static	getInstanceByServerId ($a_server_id)
	Get instance by server id. More...

static	getAvailabeMids ($a_server_id)
	Get all available mids @global $ilDB. More...

static	getExportableParticipants ($a_type)
	Get participants which are enabled and export is allowed. More...

static	getExportServers ()
	Get server ids which allow an export @global <type> $ilDB. More...

static	deleteByServer ($a_server_id)
	Delete by server @global $ilDB. More...

static	loookupCmsMid ($a_server_id)
	Lookup mid of current cms participant @global $ilDB. More...

Private Member Functions
	__construct ($a_server_id)
	Constructor (Singleton) More...

Private Attributes
	$export = array()

	$import = array()

	$export_type = array()

Static Private Attributes
static	$instances = null

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 32 of file class.ilECSParticipantSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSParticipantSettings::__construct ( $a_server_id )

private

Constructor (Singleton)

@access private

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

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

References read().

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilECSParticipantSettings::_getInstance ( )

static

get instance

@access public

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

    {
        $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Using deprecated call');
        $GLOBALS['DIC']['ilLog']->logStack();
        return self::getInstanceByServerId(15);
    }

References $GLOBALS, and getInstanceByServerId().

Here is the call graph for this function:

◆ deleteByServer()

static ilECSParticipantSettings::deleteByServer ( $a_server_id )

static

Delete by server @global $ilDB.

Parameters

int $a_server_id

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'DELETE from ecs_part_settings ' .
            'WHERE sid = ' . $ilDB->quote($a_server_id, 'integer');
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $query.

Referenced by ilECSSettingsGUI\doDelete().

Here is the caller graph for this function:

◆ getAvailabeMids()

static ilECSParticipantSettings::getAvailabeMids ( $a_server_id )

static

Get all available mids @global $ilDB.

Parameters

type $a_server_id

Returns: type

Definition at line 85 of file class.ilECSParticipantSettings.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT mid FROM ecs_part_settings ' .
                'WHERE sid = ' . $ilDB->quote($a_server_id, 'integer');
        $res = $ilDB->query($query);
        
        $mids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $mids[] = $row->mid;
        }
        return $mids;
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSSettingsGUI\refreshParticipants().

Here is the caller graph for this function:

◆ getEnabledParticipants()

ilECSParticipantSettings::getEnabledParticipants ( )

get number of participants that are enabled

@access public

Deprecated:

Definition at line 247 of file class.ilECSParticipantSettings.php.

    {
        $ret = array();
        foreach ($this->export as $mid => $enabled) {
            if ($enabled) {
                $ret[] = $mid;
            }
        }
        return $ret;
        #return $this->enabled ? $this->enabled : array();
    }

References $ret.

◆ getExportableParticipants()

static ilECSParticipantSettings::getExportableParticipants ( $a_type )

static

Get participants which are enabled and export is allowed.

Definition at line 106 of file class.ilECSParticipantSettings.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'SELECT sid,mid,export_types FROM ecs_part_settings ep ' .
            'JOIN ecs_server es ON ep.sid = es.server_id ' .
            'WHERE export = ' . $ilDB->quote(1, 'integer') . ' ' .
            'AND active = ' . $ilDB->quote(1, 'integer') . ' ' .
            'ORDER BY cname,es.title';
        
        $res = $ilDB->query($query);
        $mids = array();
        $counter = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if (in_array($a_type, (array) unserialize($row->export_types))) {
                $mids[$counter]['sid'] = $row->sid;
                $mids[$counter]['mid'] = $row->mid;
                $counter++;
            }
        }
        return $mids;
    }

References $a_type, $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSObjectSettings\addSettingsToForm().

Here is the caller graph for this function:

◆ getExportServers()

static ilECSParticipantSettings::getExportServers ( )

static

Get server ids which allow an export @global <type> $ilDB.

Returns: <type>

Definition at line 136 of file class.ilECSParticipantSettings.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'SELECT DISTINCT(sid) FROM ecs_part_settings  ep ' .
            'JOIN ecs_server es ON ep.sid = es.server_id ' .
            'WHERE export = ' . $ilDB->quote(1, 'integer') . ' ' .
            'AND active = ' . $ilDB->quote(1, 'integer') . ' ';
        $res = $ilDB->query($query);
        $sids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $sids[] = $row->sid;
        }
        return $sids;
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSObjectSettings\handleSettingsUpdate().

Here is the caller graph for this function:

◆ getInstanceByServerId()

static ilECSParticipantSettings::getInstanceByServerId ( $a_server_id )

static

Get instance by server id.

Parameters

int $a_server_id

Returns: ilECSParticipantSettings

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

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

Referenced by _getInstance(), ilECSCommunityReader\getEnabledParticipants(), and ilRemoteObjectBase\handleUpdate().

Here is the caller graph for this function:

◆ getServerId()

ilECSParticipantSettings::getServerId ( )

Get server id.

Returns: int

Definition at line 197 of file class.ilECSParticipantSettings.php.

    {
        return $this->server_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ isEnabled()

ilECSParticipantSettings::isEnabled ( $a_mid )

is partivcipant enabled

@access public

Parameters

int mid

Deprecated:

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

    {
        return $this->export[$a_mid] ? true : false;
    }

◆ isImportAllowed()

ilECSParticipantSettings::isImportAllowed ( array $a_mids )

Check if import is allowed for scecific mid.

Parameters

array $a_mids

Returns: <type>

Definition at line 231 of file class.ilECSParticipantSettings.php.

    {
        foreach ($a_mids as $mid) {
            if ($this->import[$mid]) {
                return true;
            }
        }
        return false;
    }

◆ loookupCmsMid()

static ilECSParticipantSettings::loookupCmsMid ( $a_server_id )

static

Lookup mid of current cms participant @global $ilDB.

Parameters

int $a_server_id

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php';
        
        $query = 'SELECT mid FROM ecs_part_settings ' .
                'WHERE sid = ' . $ilDB->quote($a_server_id, 'integer') . ' ' .
                'AND import_type = ' . $ilDB->quote(ilECSParticipantSetting::IMPORT_CMS);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->mid;
        }
        return 0;
    }

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilECSParticipantSetting\IMPORT_CMS.

Referenced by ilECSCmsTreeCommandQueueHandler\init(), and ilECSMappingSettingsGUI\setTabs().

Here is the caller graph for this function:

◆ read()

ilECSParticipantSettings::read ( )

Read stored entry.

Returns: <type>

Definition at line 207 of file class.ilECSParticipantSettings.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'SELECT * FROM ecs_part_settings ' .
            'WHERE sid = ' . $ilDB->quote($this->getServerId(), 'integer') . ' ';
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->export[$row->mid] = $row->export;
            $this->import[$row->mid] = $row->import;
            $this->import_type[$row->mid] = $row->import_type;
            $this->export_types[$row->mid] = (array) unserialize($row->export_types);
            $this->import_types[$row->mid] = (array) unserialize($row->import_types);
        }
        return true;
    }

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and getServerId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEnabledParticipants()

ilECSParticipantSettings::setEnabledParticipants ( $a_parts )

set enabled participants by community

@access public

Parameters

int	community id
array	participant ids

Definition at line 279 of file class.ilECSParticipantSettings.php.

    {
        $this->enabled = (array) $a_parts;
    }

Field Documentation

◆ $export

ilECSParticipantSettings::$export = array()

private

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

◆ $export_type

ilECSParticipantSettings::$export_type = array()

private

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

◆ $import

ilECSParticipantSettings::$import = array()

private

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

◆ $instances

ilECSParticipantSettings::$instances = null

staticprivate

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

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

Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ deleteByServer()

◆ getAvailabeMids()

◆ getEnabledParticipants()

◆ getExportableParticipants()

◆ getExportServers()

◆ getInstanceByServerId()

◆ getServerId()

◆ isEnabled()

◆ isImportAllowed()

◆ loookupCmsMid()

◆ read()

◆ setEnabledParticipants()

Field Documentation

◆ $export

◆ $export_type

◆ $import

◆ $instances