Collaboration diagram for ilECSCommunityReader:

Public Member Functions
	getServer ()
	Get server setting. More...

	getParticipants ()
	Get participants. More...

	getOwnMIDs ()
	get publishable ids More...

	getCommunities ()
	get communities More...

	getCommunityById ($a_id)
	get community by id More...

	getParticipantsByPid ($a_pid)

	getParticipantByMID ($a_mid)
	get participant by id More...

	getCommunityByMID ($a_mid)
	Get community by mid. More...

	getPublishableParticipants ()
	get publishable communities More...

	getEnabledParticipants ()
	get enabled participants More...

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

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

Protected Attributes
	$position = 0

	$log

	$settings = null

	$connector = null

	$communities = array()

	$participants = array()

	$own_ids = array()

Private Member Functions
	__construct (ilECSSetting $setting=null)
	Singleton constructor. More...

	read ()
	Read @access private. More...

Static Private Attributes
static	$instances = null

Detailed Description

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

Version: $Id$

@ilCtrl_Calls

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

Constructor & Destructor Documentation

◆ __construct()

ilECSCommunityReader::__construct ( ilECSSetting $setting = null )

private

Singleton constructor.

@access private

Exceptions

ilECSConnectorException

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

    {
        global $ilLog;
        
        include_once('Services/WebServices/ECS/classes/class.ilECSSetting.php');
        include_once('Services/WebServices/ECS/classes/class.ilECSConnector.php');
        include_once('Services/WebServices/ECS/classes/class.ilECSConnectorException.php');
        include_once('Services/WebServices/ECS/classes/class.ilECSCommunity.php');
 
        if ($setting) {
            $this->settings = $setting;
        } else {
            $GLOBALS['ilLog']->write(__METHOD__ . ': Using deprecated call');
            $GLOBALS['ilLog']->logStack();
        }
        $this->connector = new ilECSConnector($this->settings);
        $this->log = $ilLog;
        
        $this->read();
    }

References $GLOBALS, $ilLog, read(), and settings().

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilECSCommunityReader::_getInstance ( )

static

get singleton instance

@access public

Returns: ilECSCommunityReader

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

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

References $GLOBALS, and getInstanceByServerId().

Referenced by ilECSSettingsGUI\exportImported().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommunities()

ilECSCommunityReader::getCommunities ( )

get communities

@access public

Returns: \ilECSCommunity[]

Definition at line 139 of file class.ilECSCommunityReader.php.

    {
        return $this->communities ? $this->communities : array();
    }

Referenced by getEnabledParticipants(), getParticipantsByPid(), and getPublishableParticipants().

Here is the caller graph for this function:

◆ getCommunityById()

ilECSCommunityReader::getCommunityById ( $a_id )

get community by id

@access public

Parameters

int comm_id

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

    {
        foreach ($this->communities as $community) {
            if ($community->getId() == $a_id) {
                return $community;
            }
        }
        return null;
    }

◆ getCommunityByMID()

ilECSCommunityReader::getCommunityByMID ( $a_mid )

Get community by mid.

Parameters

int $a_mid

Returns: ilECSCommunity

Definition at line 194 of file class.ilECSCommunityReader.php.

    {
        foreach ($this->communities as $community) {
            foreach ($community->getParticipants() as $part) {
                if ($part->getMID() == $a_mid) {
                    return $community;
                }
            }
        }
        return null;
    }

◆ getEnabledParticipants()

ilECSCommunityReader::getEnabledParticipants ( )

get enabled participants

@access public

Definition at line 230 of file class.ilECSCommunityReader.php.

    {
        include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php';
        $ps = ilECSParticipantSettings::getInstanceByServerId($this->getServer()->getServerId());
        $en = $ps->getEnabledParticipants();
        foreach ($this->getCommunities() as $community) {
            foreach ($community->getParticipants() as $participant) {
                if (in_array($participant->getMid(), $en)) {
                    $e_part[] = $participant;
                }
            }
        }
        return $e_part ? $e_part : array();
    }

References getCommunities(), ilECSParticipantSettings\getInstanceByServerId(), and getServer().

Here is the call graph for this function:

◆ getInstanceByServerId()

static ilECSCommunityReader::getInstanceByServerId ( $a_server_id )

static

Get instance by server id.

Parameters

int $a_server_id

Returns: ilECSCommunityReader

Definition at line 95 of file class.ilECSCommunityReader.php.

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

References ilECSSetting\getInstanceByServerId().

Referenced by _getInstance(), ilECSSettingsGUI\communities(), ilECSUtils\lookupParticipantName(), ilECSImportedContentTableGUI\parse(), ilECSTaskScheduler\readMIDs(), ilECSSettingsGUI\refreshParticipants(), ilECSObjectSettings\sendNewContentNotification(), ilECSSettingsGUI\updateCommunities(), ilECSSettingsGUI\updateTitle(), ilAuthContainerECS\validateHash(), and ilAuthProviderECS\validateHash().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOwnMIDs()

ilECSCommunityReader::getOwnMIDs ( )

get publishable ids

@access public

Definition at line 128 of file class.ilECSCommunityReader.php.

    {
        return $this->own_ids ? $this->own_ids : array();
    }

◆ getParticipantByMID()

ilECSCommunityReader::getParticipantByMID ( $a_mid )

get participant by id

@access public

Parameters

int mid

Definition at line 184 of file class.ilECSCommunityReader.php.

    {
        return isset($this->participants[$a_mid]) ? $this->participants[$a_mid] : false;
    }

◆ getParticipants()

ilECSCommunityReader::getParticipants ( )

Get participants.

Returns: ilECSParticipant[]

Definition at line 116 of file class.ilECSCommunityReader.php.

    {
        return $this->participants;
    }

References $participants.

◆ getParticipantsByPid()

ilECSCommunityReader::getParticipantsByPid ( $a_pid )

Parameters

int $a_pid

Returns: \ilECSParticipant[]

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

    {
        $participants = [];
        foreach ($this->getCommunities() as $community) {
            foreach ($community->getParticipants() as $participant) {
                if ($participant->getPid() == $a_pid) {
                    $participants[] = $participant;
                }
            }
        }
        return $participants;
    }

References $participants, and getCommunities().

Here is the call graph for this function:

◆ getPublishableParticipants()

ilECSCommunityReader::getPublishableParticipants ( )

get publishable communities

@access public

Definition at line 212 of file class.ilECSCommunityReader.php.

    {
        foreach ($this->getCommunities() as $community) {
            foreach ($community->getParticipants() as $participant) {
                if ($participant->isPublishable()) {
                    $p_part[] = $participant;
                }
            }
        }
        return $p_part ? $p_part : array();
    }

References getCommunities().

Here is the call graph for this function:

◆ getServer()

ilECSCommunityReader::getServer ( )

Get server setting.

Returns: ilECSSetting

Definition at line 107 of file class.ilECSCommunityReader.php.

    {
        return $this->settings;
    }

References $settings.

Referenced by getEnabledParticipants().

Here is the caller graph for this function:

◆ read()

ilECSCommunityReader::read ( )

private

Read @access private.

Exceptions

ilECSConnectorException

Definition at line 251 of file class.ilECSCommunityReader.php.

    {
        global $ilLog;
        
        try {
            $res = $this->connector->getMemberships();
            if (!is_array($res->getResult())) {
                return false;
            }
            foreach ($res->getResult() as $community) {
                $tmp_comm = new ilECSCommunity($community);
                foreach ($tmp_comm->getParticipants() as $participant) {
                    $this->participants[$participant->getMID()] = $participant;
                    if ($participant->isSelf()) {
                        $this->own_ids[] = $participant->getMID();
                    }
                }
                $this->communities[] = $tmp_comm;
            }
        } catch (ilECSConnectorException $e) {
            $ilLog->write(__METHOD__ . ': Error connecting to ECS server. ' . $e->getMessage());
            throw $e;
        }
    }

References $ilLog, and $res.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $communities

ilECSCommunityReader::$communities = array()

protected

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

◆ $connector

ilECSCommunityReader::$connector = null

protected

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

◆ $instances

ilECSCommunityReader::$instances = null

staticprivate

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

◆ $log

ilECSCommunityReader::$log

protected

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

◆ $own_ids

ilECSCommunityReader::$own_ids = array()

protected

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

◆ $participants

ilECSCommunityReader::$participants = array()

protected

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

Referenced by getParticipants(), and getParticipantsByPid().

◆ $position

ilECSCommunityReader::$position = 0

protected

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

◆ $settings

ilECSCommunityReader::$settings = null

protected

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

Referenced by getServer().

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ getCommunities()

◆ getCommunityById()

◆ getCommunityByMID()

◆ getEnabledParticipants()

◆ getInstanceByServerId()

◆ getOwnMIDs()

◆ getParticipantByMID()

◆ getParticipants()

◆ getParticipantsByPid()

◆ getPublishableParticipants()

◆ getServer()

◆ read()

Field Documentation

◆ $communities

◆ $connector

◆ $instances

◆ $log

◆ $own_ids

◆ $participants

◆ $position

◆ $settings