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 ($json)
	Load from JSON object. More...

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

Data Fields
	$senders = array()

	$sender_index = null

	$receivers = array()

	$url = array()

	$content_type = array()

	$owner = 0

Private Attributes
	$receiver_info = array()

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilECSEContentDetails::__construct ( )

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

44 {

45 }

Member Function Documentation

◆ getFirstReceiver()

ilECSEContentDetails::getFirstReceiver ( )

Get first receiver.

Returns: int

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

References getReceivers().

     {
         foreach ($this->getReceivers() as $mid) {
             return $mid;
         }
         return 0;
     }

Here is the call graph for this function:

◆ getFirstSender()

ilECSEContentDetails::getFirstSender ( )

get first sender

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

     {
         return isset($this->senders[0]) ? $this->senders[0] : 0;
     }

◆ getInstance()

static ilECSEContentDetails::getInstance	(	$a_server_id,
		$a_econtent_id,
		$a_resource_type
	)

static

Get data from server.

Parameters

int	$a_server_id
int	$a_econtent_id
string	$a_resource_type

Returns: ilECSEContentDetails

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

References $ilLog, $res, ilECSSetting\getInstanceByServerId(), and ilECSConnector\HTTP_CODE_NOT_FOUND.

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

     {
         global $ilLog;
         
         try {
             include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
             include_once './Services/WebServices/ECS/classes/class.ilECSConnector.php';
             $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;
             }
             if (!is_object($res->getResult())) {
                 $ilLog->write(__METHOD__ . ': Error parsing result. Expected result of type array.');
                 $ilLog->logStack();
                 throw new ilECSConnectorException('error parsing json');
             }
         } catch (ilECSConnectorException $exc) {
             return;
         }
 
         include_once './Services/WebServices/ECS/classes/class.ilECSEContentDetails.php';
         $details = new self();
         $details->loadFromJSON($res->getResult());
         return $details;
     }

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

References $sender_index.

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

◆ getOwner()

ilECSEContentDetails::getOwner ( )

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

References $owner.

     {
         return (int) $this->owner;
     }

◆ getReceiverInfo()

ilECSEContentDetails::getReceiverInfo ( )

Get receiver info.

Returns: array

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

References $receiver_info, and array.

     {
         return (array) $this->receiver_info;
     }

◆ getReceivers()

ilECSEContentDetails::getReceivers ( )

Get recievers.

Returns: <type>

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

References $receivers, and array.

Referenced by getFirstReceiver(), and loadFromJson().

     {
         return (array) $this->receivers;
     }

Here is the caller graph for this function:

◆ getSenders()

ilECSEContentDetails::getSenders ( )

Get senders.

Returns: array

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

References $senders, and array.

     {
         return (array) $this->senders;
     }

◆ getUrl()

ilECSEContentDetails::getUrl ( )

Get url.

Returns: string

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

References $url.

     {
         return $this->url;
     }

◆ loadFromJson()

ilECSEContentDetails::loadFromJson ( $json )

Load from JSON object.

public

Parameters

object JSON object

Exceptions

ilException

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

References $i, $ilLog, $index, array, and getReceivers().

     {
         global $ilLog;
 
         if (!is_object($json)) {
             $ilLog->write(__METHOD__ . ': Cannot load from JSON. No object given.');
             throw new ilException('Cannot parse ECS content details.');
         }
 
         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 and $this->sender_index === null) {
                 $this->sender_index = $index;
             }
             ++$index;
         }
 
         // Collect in one array
         for ($i = 0; $i < count($this->getReceivers()); ++$i) {
             $this->receiver_info[$this->sender[$i]] = $this->receivers[$i];
         }
 
         if (is_object($json->owner)) {
             $this->owner = (int) $json->owner->pid;
         }
 
         $this->url = $json->url;
         $this->content_type = $json->content_type;
         return true;
     }