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

Private Attributes
int	$position = 0

ilLogger	$logger

ilECSSetting	$settings

ilECSConnector	$connector

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

Constructor & Destructor Documentation

◆ __construct()

ilECSCommunityReader::__construct ( ilECSSetting $setting )

private

Singleton constructor.

private

Exceptions

ilECSConnectorException

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getCommunities()

ilECSCommunityReader::getCommunities ( )

get communities

public

Returns: []

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

Referenced by getEnabledParticipants(), and getParticipantsByPid().

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

Here is the caller graph for this function:

◆ getCommunityById()

ilECSCommunityReader::getCommunityById ( $a_id )

get community by id

public

Parameters

int comm_id

Definition at line 111 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 158 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;
     }

◆ getEnabledParticipants()

ilECSCommunityReader::getEnabledParticipants ( )

get enabled participants

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

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

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

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

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().

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

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

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

◆ getParticipantByMID()

ilECSCommunityReader::getParticipantByMID ( $a_mid )

get participant by id

public

Parameters

int mid

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

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

◆ getParticipantNameByMid()

ilECSCommunityReader::getParticipantNameByMid ( $a_mid )

Definition at line 148 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 80 of file class.ilECSCommunityReader.php.

References $participants.

                                      : array
     {
         return $this->participants;
     }

◆ getParticipantsByPid()

ilECSCommunityReader::getParticipantsByPid ( int $a_pid )

Returns: []

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

References $participants, and getCommunities().

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

Here is the call graph for this function:

◆ getServer()

ilECSCommunityReader::getServer ( )

Get server setting.

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

References $settings.

Referenced by getEnabledParticipants().

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

Here is the caller graph for this function:

◆ read()

ilECSCommunityReader::read ( )

private

Read.

Exceptions

ilECSConnectorException

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

References Vendor\Package\$e, $res, and ILIAS\Repository\logger().

Referenced by __construct().

                            : 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;
             }
         } catch (ilECSConnectorException $e) {
             $this->logger->error(__METHOD__ . ': Error connecting to ECS server. ' . $e->getMessage());
             throw $e;
         }
     }