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 26 of file class.ilECSEContentDetails.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSEContentDetails::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getFirstReceiver()

ilECSEContentDetails::getFirstReceiver ( )

Get first receiver.

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

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

◆ getFirstSender()

ilECSEContentDetails::getFirstSender ( )

get first sender

Definition at line 87 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 47 of file class.ilECSEContentDetails.php.

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

References loadFromServer().

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

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 96 of file class.ilECSEContentDetails.php.

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

References $sender_index.

◆ getOwner()

ilECSEContentDetails::getOwner ( )

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

                              : int
    {
        return $this->owner;
    }

References $owner.

◆ getReceiverInfo()

ilECSEContentDetails::getReceiverInfo ( )

Get receiver info.

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

                                     : array
    {
        return $this->receiver_info;
    }

References $receiver_info.

◆ getReceivers()

ilECSEContentDetails::getReceivers ( )

Get recievers.

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

                                  : array
    {
        return $this->receivers;
    }

References $receivers.

Referenced by loadFromJson().

Here is the caller graph for this function:

◆ getSenders()

ilECSEContentDetails::getSenders ( )

Get senders.

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

                                : array
    {
        return $this->senders;
    }

References $senders.

◆ getUrl()

ilECSEContentDetails::getUrl ( )

Get url.

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

                            : string
    {
        return $this->url;
    }

References $url.

◆ loadFromJson()

ilECSEContentDetails::loadFromJson ( object $json )

Load from JSON object.

Parameters

object JSON object

Exceptions

ilException

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

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

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

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 58 of file class.ilECSEContentDetails.php.

                                                                                                  : ?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();
    }