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 (int $a_pid)

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

	getParticipantNameByMid ($a_mid)

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

	getEnabledParticipants ()
	get enabled participants More...

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

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

	read ()
	Read. More...

	createNewParticipants ()

Private Attributes
int	$position = 0

ilLogger	$logger

ilECSSetting	$settings

ilECSConnector	$connector

ilDBInterface	$database

array	$communities = array()

array	$participants = array()

array	$own_ids = array()

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.ilECSCommunityReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSCommunityReader::__construct ( ilECSSetting $setting )

private

Singleton constructor.

@access private

Exceptions

ilECSConnectorException

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->wsrv();
        $this->logger->debug(print_r($setting->getServerId(), true));
        $this->database = $DIC->database();
        $this->settings = $setting;
 
        $this->connector = new ilECSConnector($this->settings);
 
        $this->read();
        $this->logger->debug(__METHOD__ . ': Finished reading communities');
    }

References $DIC, ILIAS\Repository\database(), ilECSSetting\getServerId(), ILIAS\Repository\logger(), read(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ createNewParticipants()

ilECSCommunityReader::createNewParticipants ( )

private

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

                                            : void
    {
        $query = $this->database->queryF(
            "SELECT mid FROM ecs_part_settings WHERE sid = %s",
            [ilDBConstants::T_INTEGER],
            [$this->connector->getServer()->getServerId()]
        );
        $existing_ids = array_map(fn($row) => $row['mid'], $this->database->fetchAll($query));
        $missing_ids = array_diff(array_keys($this->participants), $existing_ids);
 
        foreach ($missing_ids as $mid) {
            $participant = $this->getParticipantByMID($mid);
            $community = $this->getCommunityByMID($mid);
 
            $part_settings = ilECSParticipantSetting::getInstance($this->getServer()->getServerId(), $mid);
            $part_settings->setTitle($participant->getParticipantName());
            $part_settings->setCommunityName($community->getTitle());
            $part_settings->update();
        }
    }

References ILIAS\Repository\database(), getCommunityByMID(), ilECSParticipantSetting\getInstance(), getParticipantByMID(), getServer(), and ilDBConstants\T_INTEGER.

Referenced by read().

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 103 of file class.ilECSCommunityReader.php.

                                    : array
    {
        return $this->communities ?: [];
    }

Referenced by getEnabledParticipants(), and getParticipantsByPid().

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 114 of file class.ilECSCommunityReader.php.

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

◆ getCommunityByMID()

ilECSCommunityReader::getCommunityByMID ( int $a_mid )

Get community by mid.

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

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

Referenced by createNewParticipants().

Here is the caller graph for this function:

◆ getEnabledParticipants()

ilECSCommunityReader::getEnabledParticipants ( )

get enabled participants

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

                                            : array
    {
        $ps = ilECSParticipantSettings::getInstanceByServerId($this->getServer()->getServerId());
        $en = $ps->getEnabledParticipants();
        $e_part = [];
        foreach ($this->getCommunities() as $community) {
            foreach ($community->getParticipants() as $participant) {
                if (in_array($participant->getMid(), $en, true)) {
                    $e_part[] = $participant;
                }
            }
        }
        return $e_part;
    }

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

Here is the call graph for this function:

◆ getInstanceByServerId()

static ilECSCommunityReader::getInstanceByServerId ( int $a_server_id )

static

Get instance by server id.

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

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

References ilECSSetting\getInstanceByServerId().

Referenced by ilECSSettingsGUI\communities(), ilECSSettingsGUI\exportImported(), ilECSUserConsentModalGUI\getOrganisation(), ilECSCategoryMappingRule\participantsToString(), ilECSTaskScheduler\readMIDs(), ilECSSettingsGUI\refreshParticipants(), ilECSObjectSettings\sendNewContentNotification(), ilECSSettingsGUI\updateCommunities(), ilRemoteObjectBase\updateFromECSContent(), ilECSSettingsGUI\updateTitle(), 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

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

                                : array
    {
        return $this->own_ids ?: [];
    }

◆ getParticipantByMID()

ilECSCommunityReader::getParticipantByMID ( $a_mid )

get participant by id

@access public

Parameters

int mid

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

    {
        return $this->participants[$a_mid] ?? false;
    }

Referenced by createNewParticipants().

Here is the caller graph for this function:

◆ getParticipantNameByMid()

ilECSCommunityReader::getParticipantNameByMid ( $a_mid )

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

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

◆ getParticipants()

ilECSCommunityReader::getParticipants ( )

Get participants.

Returns: ilECSParticipant[]

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

                                     : array
    {
        return $this->participants;
    }

References $participants.

◆ getParticipantsByPid()

ilECSCommunityReader::getParticipantsByPid ( int $a_pid )

Returns: \ilECSParticipant[]

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

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

◆ getServer()

ilECSCommunityReader::getServer ( )

Get server setting.

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

                               : \ilECSSetting
    {
        return $this->settings;
    }

References $settings.

Referenced by createNewParticipants(), and getEnabledParticipants().

Here is the caller graph for this function:

◆ read()

ilECSCommunityReader::read ( )

private

Read.

Exceptions

ilECSConnectorException

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

                           : void
    {
        try {
            $res = $this->connector->getMemberships();
 
            if (!is_array($res->getResult())) {
                return;
            }
            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;
            }
 
            $this->createNewParticipants();
        } catch (ilECSConnectorException $e) {
            $this->logger->error(__METHOD__ . ': Error connecting to ECS server. ' . $e->getMessage());
            throw $e;
        }
    }