ilECSParticipantSettings Class Reference

Collaboration diagram for ilECSParticipantSettings:

Public Member Functions
	getAvailabeMids ()
	Get all available mids. More...
	lookupCmsMid ()
	Lookup mid of current cms participant. More...
	getServerId ()
	Get server id. More...
	isImportAllowed (array $a_mids)
	Check if import is allowed for specific mid. More...
	getEnabledParticipants ()
	get number of participants that are enabled More...
	isEnabled ($a_mid)
	is participant enabled More...

Static Public Member Functions
static	getInstanceByServerId (int $a_server_id)
	Get instance by server id. More...

Private Member Functions
	__construct (int $a_server_id)
	Constructor (Singleton) More...
	read ()
	Read stored entry. More...

Private Attributes
array	$export = array()
array	$import = array()
int	$server_id
ilDBInterface	$db

Static Private Attributes
static array	$instances = null

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilECSParticipantSettings::__construct ( int  $a_server_id )

private

Constructor (Singleton)

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

References $DIC, and read().

    {
        global $DIC;

        $this->db = $DIC['ilDB'];
        $this->server_id = $a_server_id;
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

getAvailabeMids()

ilECSParticipantSettings::getAvailabeMids

(

)

Get all available mids.

Returns

int[] membership id

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

                                     : array
    {
        $query = 'SELECT mid FROM ecs_part_settings ' .
            'WHERE sid = ' . $this->db->quote($this->server_id, 'integer');
        $res = $this->db->query($query);

        $mids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $mids[] = (int) $row->mid;
        }
        return $mids;
    }

Here is the call graph for this function:

getEnabledParticipants()

ilECSParticipantSettings::getEnabledParticipants

(

)

get number of participants that are enabled

Deprecated:

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

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

getInstanceByServerId()

static ilECSParticipantSettings::getInstanceByServerId ( int  $a_server_id )

static

Get instance by server id.

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

Referenced by ilECSCommunityReader\getEnabledParticipants(), ilRemoteObjectBase\handleUpdate(), ilECSCmsTreeCommandQueueHandler\init(), ilECSSettingsGUI\refreshParticipants(), and ilECSMappingSettingsGUI\setTabs().

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

Here is the caller graph for this function:

getServerId()

ilECSParticipantSettings::getServerId

(

)

Get server id.

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

References $server_id.

Referenced by read().

                                 : int
    {
        return $this->server_id;
    }

Here is the caller graph for this function:

isEnabled()

ilECSParticipantSettings::isEnabled

(

$a_mid

)

is participant enabled

Parameters

int

mid

Deprecated:

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

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

isImportAllowed()

ilECSParticipantSettings::isImportAllowed

(

array

$a_mids

)

Check if import is allowed for specific mid.

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

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

lookupCmsMid()

ilECSParticipantSettings::lookupCmsMid

(

)

Lookup mid of current cms participant.

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

References $res, ilDBConstants\FETCHMODE_OBJECT, and ilECSParticipantSetting\IMPORT_CMS.

                                  : int
    {
        $query = 'SELECT mid FROM ecs_part_settings ' .
                'WHERE sid = ' . $this->db->quote($this->server_id, 'integer') . ' ' .
                'AND import_type = ' . $this->db->quote(ilECSParticipantSetting::IMPORT_CMS);
        $res = $this->db->query($query);
        if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->mid;
        }
        return 0;
    }

read()

ilECSParticipantSettings::read ( )

private

Read stored entry.

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

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

Referenced by __construct().

                           : void
    {
        $query = 'SELECT * FROM ecs_part_settings ' .
            'WHERE sid = ' . $this->db->quote($this->getServerId(), 'integer') . ' ';
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->export[$row->mid] = $row->export;
            $this->import[$row->mid] = $row->import;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilECSParticipantSettings::$db

private

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

$export

array ilECSParticipantSettings::$export = array()

private

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

$import

array ilECSParticipantSettings::$import = array()

private

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

$instances

array ilECSParticipantSettings::$instances = null

staticprivate

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

$server_id

int ilECSParticipantSettings::$server_id

private

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

Referenced by getServerId().

---

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

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