Presentation of ecs content details (http://...campusconnect/courselinks/id/details) More...

Collaboration diagram for ilECSEContentDetails:

Public Member Functions
	__construct ()

	getSenders ()
	Get senders. More...

	getFirstSender ()
	get first sender More...

	getMySender ()
	Get sender from whom we received the ressource According to the documentation the sender and receiver arrays have corresponding indexes. More...

	getReceivers ()
	Get recievers. More...

	getFirstReceiver ()
	Get first receiver. More...

	getReceiverInfo ()
	Get receiver info. More...

	getUrl ()
	Get url. More...

	getOwner ()

	loadFromJson (object $json)
	Load from JSON object. More...

Static Public Member Functions
static	getInstanceFromServer (int $a_server_id, int $a_econtent_id, string $a_resource_type)
	Get data from server. More...

Private Member Functions
	loadFromServer (int $a_server_id, int $a_econtent_id, string $a_resource_type)

Private Attributes
array	$senders = []

int	$sender_index = null

array	$receivers = []

string	$url = ""

int	$owner = 0

array	$receiver_info = []

ilLogger	$logger

Detailed Description

Presentation of ecs content details (http://...campusconnect/courselinks/id/details)

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilECSEContentDetails.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSEContentDetails::__construct ( )

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

References $DIC, and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->wsrv();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getFirstReceiver()

ilECSEContentDetails::getFirstReceiver ( )

Get first receiver.

Definition at line 111 of file class.ilECSEContentDetails.php.

                                       : int
     {
         return count($this->receivers) ? $this->receivers[0] : 0;
     }

◆ getFirstSender()

ilECSEContentDetails::getFirstSender ( )

get first sender

Definition at line 86 of file class.ilECSEContentDetails.php.

                                     : int
     {
         return $this->senders[0] ?? 0;
     }

◆ getInstanceFromServer()

static ilECSEContentDetails::getInstanceFromServer	(	int	$a_server_id,
		int	$a_econtent_id,
		string	$a_resource_type
	)

static

Get data from server.

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

References loadFromServer().

Referenced by ilECSObjectSettings\addSettingsToForm(), ilECSObjectSettings\getParticipants(), ilECSObjectSettings\getValueForECSExportOptionalGroup(), ilRemoteObjectBase\handleUpdate(), and ilECSObjectSettings\sendNewContentNotification().

                                                                                                                : ilECSEContentDetails
     {
         $instance = new self();
         $detailsOnServer = $instance->loadFromServer($a_server_id, $a_econtent_id, $a_resource_type);
         if ($detailsOnServer) {
             $instance->loadFromJson($detailsOnServer);
         }
         return $instance;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMySender()

ilECSEContentDetails::getMySender ( )

Get sender from whom we received the ressource According to the documentation the sender and receiver arrays have corresponding indexes.

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

References $sender_index.

                                  : int
     {
         return $this->senders[$this->sender_index];
     }

◆ getOwner()

ilECSEContentDetails::getOwner ( )

Definition at line 132 of file class.ilECSEContentDetails.php.

References $owner.

                               : int
     {
         return $this->owner;
     }

◆ getReceiverInfo()

ilECSEContentDetails::getReceiverInfo ( )

Get receiver info.

Definition at line 119 of file class.ilECSEContentDetails.php.

References $receiver_info.

                                      : array
     {
         return $this->receiver_info;
     }

◆ getReceivers()

ilECSEContentDetails::getReceivers ( )

Get recievers.

Definition at line 103 of file class.ilECSEContentDetails.php.

References $receivers.

Referenced by loadFromJson().

                                   : array
     {
         return $this->receivers;
     }

Here is the caller graph for this function:

◆ getSenders()

ilECSEContentDetails::getSenders ( )

Get senders.

Definition at line 78 of file class.ilECSEContentDetails.php.

References $senders.

                                 : array
     {
         return $this->senders;
     }

◆ getUrl()

ilECSEContentDetails::getUrl ( )

Get url.

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

References $url.

                             : string
     {
         return $this->url;
     }

◆ loadFromJson()

ilECSEContentDetails::loadFromJson ( object $json )

Load from JSON object.

Parameters

object JSON object

Exceptions

ilException

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

References getReceivers(), ILIAS\Repository\int(), and ILIAS\Repository\logger().

                                               : bool
     {
         $this->logger->info(print_r($json, true));
         foreach ((array) $json->senders as $sender) {
             $this->senders[] = $sender->mid;
         }
 
         $index = 0;
         foreach ((array) $json->receivers as $receiver) {
             $this->receivers[] = $receiver->mid;
             if ($receiver->itsyou && $this->sender_index === null) {
                 $this->sender_index = $index;
             }
             ++$index;
         }
 
         // Collect in one array
         for ($i = 0, $iMax = count($this->getReceivers()); $i < $iMax; ++$i) {
             $this->receiver_info[$this->senders[$i]] = $this->receivers[$i];
         }
 
         if (is_object($json->owner)) {
             $this->owner = (int) $json->owner->pid;
         }
 
         $this->url = $json->url;
         return true;
     }

Here is the call graph for this function:

◆ loadFromServer()

ilECSEContentDetails::loadFromServer	(	int	$a_server_id,
		int	$a_econtent_id,
		string	$a_resource_type
	)

private

Definition at line 57 of file class.ilECSEContentDetails.php.

References $res, ilECSSetting\getInstanceByServerId(), ilECSConnector\HTTP_CODE_NOT_FOUND, and ILIAS\Repository\logger().

Referenced by getInstanceFromServer().

                                                                                                   : ?object
     {
         try {
             $connector = new ilECSConnector(ilECSSetting::getInstanceByServerId($a_server_id));
             $res = $connector->getResource($a_resource_type, $a_econtent_id, true);
             if ($res->getHTTPCode() === ilECSConnector::HTTP_CODE_NOT_FOUND) {
                 return null;
             }
             if (!is_object($res->getResult())) {
                 $this->logger->error(__METHOD__ . ': Error parsing result. Expected result of type array.');
                 $this->logger->logStack();
                 throw new ilECSConnectorException('error parsing json');
             }
         } catch (ilECSConnectorException $exc) {
             return null;
         }
         return $res->getResult();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $logger

ilLogger ilECSEContentDetails::$logger

private

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

◆ $owner

int ilECSEContentDetails::$owner = 0

private

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

Referenced by getOwner().

◆ $receiver_info

array ilECSEContentDetails::$receiver_info = []

private

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

Referenced by getReceiverInfo().

◆ $receivers

array ilECSEContentDetails::$receivers = []

private

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

Referenced by getReceivers().

◆ $sender_index

int ilECSEContentDetails::$sender_index = null

private

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

Referenced by getMySender().

◆ $senders

array ilECSEContentDetails::$senders = []

private

Definition at line 27 of file class.ilECSEContentDetails.php.

Referenced by getSenders().

◆ $url

string ilECSEContentDetails::$url = ""

private

Definition at line 30 of file class.ilECSEContentDetails.php.

Referenced by getUrl().

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

components/ILIAS/WebServices/ECS/classes/class.ilECSEContentDetails.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFirstReceiver()

◆ getFirstSender()

◆ getInstanceFromServer()

◆ getMySender()

◆ getOwner()

◆ getReceiverInfo()

◆ getReceivers()

◆ getSenders()

◆ getUrl()

◆ loadFromJson()

◆ loadFromServer()

Field Documentation

◆ $logger

◆ $owner

◆ $receiver_info

◆ $receivers

◆ $sender_index

◆ $senders

◆ $url