Inheritance diagram for ilECSConnector:

Collaboration diagram for ilECSConnector:

Public Member Functions
	__construct (ilECSSetting $settings=null)

	addHeader (string $a_name, string $a_value)
	Add Header. More...

	getHeader ()

	setHeader (array $a_header_strings)

	getServer ()
	Get current server setting. More...

	addAuth (string $a_post, int $a_target_mid)
	Add auth resource. More...

	getAuth (string $a_hash, bool $a_details_only=false)
	get auth resource More...

	readEventFifo (bool $a_delete=false)
	Read event fifo. More...

	getResourceList (string $a_path)

	getResource (string $a_path, int $a_econtent_id, bool $a_details_only=false)
	Get resources from ECS server. More...

	addResource (string $a_path, $a_post)
	Add resource. More...

	updateResource (string $a_path, int $a_econtent_id, string $a_post_string)
	update resource More...

	deleteResource (string $a_path, int $a_econtent_id)
	Delete resource. More...

	getMemberships (int $a_mid=0)

Data Fields
const	HTTP_CODE_CREATED = 201

const	HTTP_CODE_OK = 200

const	HTTP_CODE_NOT_FOUND = 404

const	HEADER_MEMBERSHIPS = 'X-EcsReceiverMemberships'

const	HEADER_COMMUNITIES = 'X-EcsReceiverCommunities'

Protected Member Functions
	prepareConnection ()
	prepare connection More...

	call ()
	call peer More...

Protected Attributes
string	$path_postfix = ''

ilECSSetting	$settings = null

ilCurlConnection	$curl = null

array	$header_strings = []

ilLogger	$logger

Private Member Functions
	_fetchEContentIdFromHeader (array $a_header)
	fetch new econtent id from location header More...

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilECSConnector.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSConnector::__construct ( ilECSSetting $settings = null )

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

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

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->wsrv();
         if ($settings) {
             $this->settings = $settings;
         } else {
             $this->logger->warning('Using deprecated call.');
             $this->logger->logStack(ilLogLevel::WARNING);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _fetchEContentIdFromHeader()

ilECSConnector::_fetchEContentIdFromHeader ( array $a_header )

private

fetch new econtent id from location header

Parameters

array header array

Definition at line 534 of file class.ilECSConnector.php.

References ILIAS\Repository\logger().

Referenced by addResource().

                                                                 : int
     {
         $location_parts = [];
         foreach ($a_header as $header => $value) {
             if (strcasecmp('Location', $header) === 0) {
                 $location_parts = explode('/', $value);
                 break;
             }
         }
         if (!$location_parts) {
             $this->logger->error(__METHOD__ . ': Cannot find location headers.');
             throw new ilECSConnectorException("Cannot find location header in response");
         }
         if (count($location_parts) === 1) {
             $this->logger->warning(__METHOD__ . ': Cannot find path seperator.');
             throw new ilECSConnectorException("Location header has wrong format: " . $location_parts[0]);
         }
         $econtent_id = end($location_parts);
         $this->logger->info(__METHOD__ . ': Received EContentId ' . $econtent_id);
         return (int) $econtent_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAuth()

ilECSConnector::addAuth	(	string	$a_post,
		int	$a_target_mid
	)

Add auth resource.

Parameters

string	$a_post	post data
int	$a_target_mid	the membership id of target server

Returns: string the new hash for this authentication

Exceptions

ilECSConnectorException

Definition at line 99 of file class.ilECSConnector.php.

References $auth, addHeader(), call(), getHeader(), ILIAS\Repository\logger(), and prepareConnection().

                                                               : string
     {
         $this->logger->info(__METHOD__ . ': Add new Auth resource...');
 
         $this->path_postfix = '/sys/auths';
 
         try {
             $this->prepareConnection();
 
             $this->addHeader('Content-Type', 'application/json');
             $this->addHeader('Accept', 'application/json');
             $this->addHeader(self::HEADER_MEMBERSHIPS, (string) $a_target_mid);
 
             $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
             $this->curl->setOpt(CURLOPT_POST, true);
             $this->curl->setOpt(CURLOPT_POSTFIELDS, $a_post);
             $ret = $this->call();
 
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
 
             $this->logger->info(__METHOD__ . ': Checking HTTP status...');
             if ($info !== self::HTTP_CODE_CREATED) {
                 $this->logger->info(__METHOD__ . ': Cannot create auth resource, did not receive HTTP 201. ');
                 $this->logger->info(__METHOD__ . ': POST was: ' . $a_post);
                 $this->logger->info(__METHOD__ . ': HTTP code: ' . $info);
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
             $this->logger->info(__METHOD__ . ': ... got HTTP 201 (created)');
             $this->logger->info(__METHOD__ . ': POST was: ' . $a_post);
 
             $result = new ilECSResult($ret);
             $auth = $result->getResult();
 
             $this->logger->info(__METHOD__ . ': ... got hash: ' . $auth->hash);
 
             return $auth->hash;
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

◆ addHeader()

ilECSConnector::addHeader	(	string	$a_name,
		string	$a_value
	)

Add Header.

Parameters

string	$a_name
string	$a_value

Definition at line 62 of file class.ilECSConnector.php.

Referenced by addAuth(), ilECSEnrolmentStatusConnector\addEnrolmentStatus(), addResource(), ilECSCourseUrlConnector\addUrl(), ilECSCourseConnector\getCourse(), ilECSCourseMemberConnector\getCourseMember(), ilECSDirectoryTreeConnector\getDirectoryTree(), ilECSDirectoryTreeConnector\getDirectoryTrees(), ilECSEnrolmentStatusConnector\getEnrolmentStatus(), readEventFifo(), and updateResource().

                                                               : void
     {
         $this->header_strings[] = ($a_name . ': ' . $a_value);
     }

Here is the caller graph for this function:

◆ addResource()

ilECSConnector::addResource	(	string	$a_path,
			$a_post
	)

Add resource.

public

Parameters

string	$a_path	resource "path"
array \| string	$a_post	post data

Returns: int new econtent id

Exceptions

ilECSConnectorException

Definition at line 308 of file class.ilECSConnector.php.

References _fetchEContentIdFromHeader(), addHeader(), call(), getHeader(), ILIAS\Repository\logger(), and prepareConnection().

                                                         : int
     {
         $this->logger->info(__METHOD__ . ': Add new EContent...');
 
         $this->path_postfix = $a_path;
 
         try {
             $this->prepareConnection();
 
             $this->addHeader('Content-Type', 'application/json');
 
             $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
             $this->curl->setOpt(CURLOPT_HEADER, true);
             $this->curl->setOpt(CURLOPT_POST, true);
             $this->curl->setOpt(CURLOPT_POSTFIELDS, $a_post);
             $this->call();
 
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
 
             $this->logger->debug(__METHOD__ . ': Checking HTTP status...');
             if ($info !== self::HTTP_CODE_CREATED) {
                 $this->logger->debug(__METHOD__ . ': Cannot create econtent, did not receive HTTP 201. ');
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
             $this->logger->debug(__METHOD__ . ': ... got HTTP 201 (created)');
 
             return $this->_fetchEContentIdFromHeader($this->curl->getResponseHeaderArray());
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

◆ call()

ilECSConnector::call ( )

protected

call peer

Returns: string|bool

Exceptions

ilCurlConnectionException

Definition at line 519 of file class.ilECSConnector.php.

References ILIAS\Repository\logger().

Referenced by addAuth(), ilECSEnrolmentStatusConnector\addEnrolmentStatus(), addResource(), ilECSCourseUrlConnector\addUrl(), deleteResource(), getAuth(), ilECSCourseConnector\getCourse(), ilECSCourseMemberConnector\getCourseMember(), ilECSDirectoryTreeConnector\getDirectoryTree(), ilECSDirectoryTreeConnector\getDirectoryTrees(), ilECSEnrolmentStatusConnector\getEnrolmentStatus(), getMemberships(), getResource(), getResourceList(), readEventFifo(), and updateResource().

     {
         try {
             return $this->curl->exec();
         } catch (ilCurlConnectionException $exc) {
             $this->logger->error($exc->getMessage());
             throw($exc);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteResource()

ilECSConnector::deleteResource	(	string	$a_path,
		int	$a_econtent_id
	)

Delete resource.

Parameters

string	$a_path	resource "path"
int	$a_econtent_id	econtent id

Exceptions

ilECSConnectorException

Definition at line 403 of file class.ilECSConnector.php.

References $res, call(), ILIAS\Repository\logger(), and prepareConnection().

                                                                       : ?ilECSResult
     {
         $this->logger->debug(__METHOD__ . ': Delete resource with id ' . $a_econtent_id);
 
         $this->path_postfix = $a_path;
 
         if ($a_econtent_id) {
             $this->path_postfix .= ('/' . $a_econtent_id);
         } else {
             throw new ilECSConnectorException('Error calling deleteResource: No content id given.');
         }
 
         try {
             $this->prepareConnection();
             $this->curl->setOpt(CURLOPT_CUSTOMREQUEST, 'DELETE');
             $res = $this->call();
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
             if (200 === $info) {
                 return new ilECSResult($res);
             }
             return null;
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

◆ getAuth()

ilECSConnector::getAuth	(	string	$a_hash,
		bool	$a_details_only = `false`
	)

get auth resource

Returns: ilECSResult|ilECSEContentDetails

Exceptions

ilECSConnectorException

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

References ILIAS\LTI\ToolProvider\$details, $res, call(), ILIAS\Repository\logger(), and prepareConnection().

     {
         if ($a_hash === '') {
             $this->logger->error(__METHOD__ . ': No auth hash given. Aborting.');
             throw new ilECSConnectorException('No auth hash given.');
         }
 
         $this->path_postfix = '/sys/auths/' . $a_hash;
 
         if ($a_details_only) {
             $this->path_postfix .= ('/details');
         }
 
 
         try {
             $this->prepareConnection();
             $res = $this->call();
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
 
             $this->logger->info(__METHOD__ . ': Checking HTTP status...');
             if ($info !== self::HTTP_CODE_OK) {
                 $this->logger->info(__METHOD__ . ': Cannot get auth resource, did not receive HTTP 200. ');
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
             $this->logger->info(__METHOD__ . ': ... got HTTP 200 (ok)');
 
             $ecs_result = new ilECSResult($res);
             // Return ECSEContentDetails for details switch
             if ($a_details_only) {
                 $details = new ilECSEContentDetails();
                 $details->loadFromJson($ecs_result->getResult());
                 return $details;
             }
             return $ecs_result;
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

◆ getHeader()

ilECSConnector::getHeader ( )

Definition at line 67 of file class.ilECSConnector.php.

References $header_strings.

Referenced by addAuth(), ilECSEnrolmentStatusConnector\addEnrolmentStatus(), addResource(), ilECSCourseUrlConnector\addUrl(), ilECSCourseConnector\getCourse(), ilECSCourseMemberConnector\getCourseMember(), ilECSDirectoryTreeConnector\getDirectoryTree(), ilECSDirectoryTreeConnector\getDirectoryTrees(), ilECSEnrolmentStatusConnector\getEnrolmentStatus(), getResourceList(), and updateResource().

                                : array
     {
         return $this->header_strings;
     }

Here is the caller graph for this function:

◆ getMemberships()

ilECSConnector::getMemberships ( int $a_mid = 0 )

Parameters

int $a_mid membership id

Exceptions

ilECSConnectorException

Definition at line 437 of file class.ilECSConnector.php.

References $res, call(), ILIAS\Repository\logger(), and prepareConnection().

                                                   : ilECSResult
     {
         $this->logger->debug(__METHOD__ . ': Get existing memberships');
 
         $this->path_postfix = '/sys/memberships';
         if ($a_mid) {
             $this->logger->debug(__METHOD__ . ': Read membership with id: ' . $a_mid);
             $this->path_postfix .= ('/' . $a_mid);
         }
         try {
             $this->prepareConnection();
             $res = $this->call();
 
             $this->curl->setOpt(CURLOPT_HTTPHEADER, array(0 => 'X-EcsQueryStrings: sender=true'));
 
             // Checking status code
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
             if ($info !== self::HTTP_CODE_OK) {
                 $this->logger->debug(__METHOD__ . ': Cannot get memberships, did not receive HTTP 200. ');
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
 
             return new ilECSResult($res);
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage() . $exc->getTraceAsString(), 0, $exc);
         }
     }

Here is the call graph for this function:

◆ getResource()

ilECSConnector::getResource	(	string	$a_path,
		int	$a_econtent_id,
		bool	$a_details_only = `false`
	)

Get resources from ECS server.

Exceptions

ilECSConnectorException

Definition at line 258 of file class.ilECSConnector.php.

References $res, call(), ILIAS\Repository\int(), ILIAS\Repository\logger(), and prepareConnection().

                                                                                                  : ilECSResult
     {
         // TODO make handling of a_econtent_id explict like setting it to null
         if ($a_econtent_id) {
             $this->logger->debug(__METHOD__ . ': Get resource with ID: ' . $a_econtent_id);
         } else {
             $this->logger->debug(__METHOD__ . ': Get all resources ...');
         }
 
         $this->path_postfix = $a_path;
         if ($a_econtent_id) {
             $this->path_postfix .= ('/' . $a_econtent_id);
         }
         if ($a_details_only) {
             $this->path_postfix .= ('/details');
         }
 
         try {
             $this->prepareConnection();
             $res = $this->call();
 
             // Checking status code
             $info = (int) $this->curl->getInfo(CURLINFO_HTTP_CODE);
             $this->logger->debug(__METHOD__ . ': Checking HTTP status...');
             if ($info !== self::HTTP_CODE_OK) {
                 $this->logger->debug(__METHOD__ . ': Cannot get ressource, did not receive HTTP 200. ');
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
             $this->logger->debug(__METHOD__ . ': ... got HTTP 200 (ok)');
 
             $result = new ilECSResult($res);
             $result->setHeaders($this->curl->getResponseHeaderArray());
             $result->setHTTPCode($info);
 
             return $result;
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

◆ getResourceList()

ilECSConnector::getResourceList ( string $a_path )

Definition at line 228 of file class.ilECSConnector.php.

References $res, call(), getHeader(), ILIAS\Repository\logger(), prepareConnection(), and ilECSResult\RESULT_TYPE_URL_LIST.

                                                    : ilECSResult
     {
         $this->path_postfix = $a_path;
 
         try {
             $this->prepareConnection();
             $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
             $res = $this->call();
 
             // Checking status code
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
             $this->logger->debug(__METHOD__ . ': Checking HTTP status...');
             if ($info !== self::HTTP_CODE_OK) {
                 $this->logger->debug(__METHOD__ . ': Cannot get ressource list, did not receive HTTP 200. ');
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
             $this->logger->debug(__METHOD__ . ': ... got HTTP 200 (ok)');
 
             return new ilECSResult($res, ilECSResult::RESULT_TYPE_URL_LIST);
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

◆ getServer()

ilECSConnector::getServer ( )

Get current server setting.

Definition at line 80 of file class.ilECSConnector.php.

References $settings.

Referenced by prepareConnection().

                                : ilECSSetting
     {
         return $this->settings;
     }

Here is the caller graph for this function:

◆ prepareConnection()

ilECSConnector::prepareConnection ( )

protected

prepare connection

Exceptions

ilCurlConnectionException

Definition at line 470 of file class.ilECSConnector.php.

References $path_postfix, ilECSSetting\AUTH_APACHE, ilECSSetting\AUTH_CERTIFICATE, ilLogLevel\DEBUG, getServer(), ilCurlConnection\init(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Referenced by addAuth(), ilECSEnrolmentStatusConnector\addEnrolmentStatus(), addResource(), ilECSCourseUrlConnector\addUrl(), deleteResource(), getAuth(), ilECSCourseConnector\getCourse(), ilECSCourseMemberConnector\getCourseMember(), ilECSDirectoryTreeConnector\getDirectoryTree(), ilECSDirectoryTreeConnector\getDirectoryTrees(), ilECSEnrolmentStatusConnector\getEnrolmentStatus(), getMemberships(), getResource(), getResourceList(), readEventFifo(), and updateResource().

                                           : void
     {
         try {
             $this->curl = new ilCurlConnection($this->settings->getServerURI() . $this->path_postfix);
             $this->curl->init(true);
             $this->curl->setOpt(CURLOPT_HTTPHEADER, array(0 => 'Accept: application/json'));
             $this->curl->setOpt(CURLOPT_RETURNTRANSFER, 1);
             $this->curl->setOpt(CURLOPT_TIMEOUT_MS, 2000);
             $this->curl->setOpt(CURLOPT_FORBID_REUSE, true);
             $this->curl->setOpt(CURLOPT_FRESH_CONNECT, true);
 
             if ($this->logger->isHandling(ilLogLevel::DEBUG)) {
                 $this->curl->setOpt(CURLOPT_VERBOSE, 1);
             }
 
             switch ($this->getServer()->getAuthType()) {
                 case ilECSSetting::AUTH_APACHE:
                     $this->curl->setOpt(CURLOPT_SSL_VERIFYPEER, 1);
                     #$this->curl->setOpt(CURLOPT_SSL_VERIFYHOST,0);
                     $this->curl->setOpt(CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
                     $this->curl->setOpt(
                         CURLOPT_USERPWD,
                         $this->getServer()->getAuthUser() . ':' . $this->getServer()->getAuthPass()
                     );
                     break;
 
                 case ilECSSetting::AUTH_CERTIFICATE:
                     $this->curl->setOpt(CURLOPT_SSL_VERIFYPEER, 1);
                     // use default 2 for libcurl 7.28.1 support
                     $this->curl->setOpt(CURLOPT_SSL_VERIFYHOST, 2);
                     $this->curl->setOpt(CURLOPT_CAINFO, $this->settings->getCACertPath());
                     $this->curl->setOpt(CURLOPT_SSLCERT, $this->settings->getClientCertPath());
                     $this->curl->setOpt(CURLOPT_SSLKEY, $this->settings->getKeyPath());
                     $this->curl->setOpt(CURLOPT_SSLKEYPASSWD, $this->settings->getKeyPassword());
                     break;
 
             }
         } catch (ilCurlConnectionException $exc) {
             throw($exc);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEventFifo()

ilECSConnector::readEventFifo ( bool $a_delete = false )

Read event fifo.

Parameters

bool $a_delete set to true for deleting the current element

Exceptions

ilECSConnectorException

Definition at line 194 of file class.ilECSConnector.php.

References $res, addHeader(), call(), ILIAS\Repository\logger(), and prepareConnection().

                                                          : ilECSResult
     {
         $this->path_postfix = '/sys/events/fifo';
 
         try {
             $this->prepareConnection();
             $this->addHeader('Content-Type', 'application/json');
             $this->addHeader('Accept', 'application/json');
 
             if ($a_delete) {
                 $this->curl->setOpt(CURLOPT_POST, true);
                 $this->curl->setOpt(CURLOPT_POSTFIELDS, '');
             }
             $res = $this->call();
 
             // Checking status code
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
             if ($info !== self::HTTP_CODE_OK) {
                 $this->logger->info(__METHOD__ . ': Cannot read event fifo, did not receive HTTP 200. ');
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
             //TODO check if this return needs to be moved after the finally
             return new ilECSResult($res);
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         } finally {
             $this->curl->close();
         }
     }

Here is the call graph for this function:

◆ setHeader()

ilECSConnector::setHeader ( array $a_header_strings )

Definition at line 72 of file class.ilECSConnector.php.

Referenced by ilECSCourseConnector\getCourse(), ilECSCourseMemberConnector\getCourseMember(), ilECSDirectoryTreeConnector\getDirectoryTree(), ilECSDirectoryTreeConnector\getDirectoryTrees(), and ilECSEnrolmentStatusConnector\getEnrolmentStatus().

                                                       : void
     {
         $this->header_strings = $a_header_strings;
     }

Here is the caller graph for this function:

◆ updateResource()

ilECSConnector::updateResource	(	string	$a_path,
		int	$a_econtent_id,
		string	$a_post_string
	)

update resource

Parameters

string	$a_path	resource "path"
int	$a_econtent_id	econtent id
string	$a_post_string	post content

Exceptions

ilECSConnectorException

Definition at line 348 of file class.ilECSConnector.php.

References $res, addHeader(), call(), getHeader(), ilFileUtils\ilTempnam(), ILIAS\Repository\logger(), and prepareConnection().

                                                                                              : void
     {
         $this->logger->debug(__METHOD__ . ': Update resource with id ' . $a_econtent_id);
 
         $this->path_postfix = $a_path;
 
         if ($a_econtent_id) {
             $this->path_postfix .= ('/' . $a_econtent_id);
         } else {
             throw new ilECSConnectorException('Error calling updateResource: No content id given.');
         }
         try {
             $this->prepareConnection();
             $this->addHeader('Content-Type', 'application/json');
             $this->addHeader('Accept', 'application/json');
             $this->addHeader('Expect', '');
             $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
             $this->curl->setOpt(CURLOPT_HEADER, true);
             $this->curl->setOpt(CURLOPT_PUT, true);
             //TODO migrate to filesystem->tempfile
             $tempfile = ilFileUtils::ilTempnam();
             $this->logger->info(__METHOD__ . ': Created new tempfile: ' . $tempfile);
 
             $fp = fopen($tempfile, 'wb');
             fwrite($fp, $a_post_string);
             fclose($fp);
 
             $this->curl->setOpt(CURLOPT_UPLOAD, true);
             $this->curl->setOpt(CURLOPT_INFILESIZE, filesize($tempfile));
             $fp = fopen($tempfile, 'rb');
             $this->curl->setOpt(CURLOPT_INFILE, $fp);
 
             $res = $this->call();
 
             fclose($fp);
             unlink($tempfile);
 
             $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
             $this->logger->debug(__METHOD__ . ': Checking HTTP status...');
             if ($info !== self::HTTP_CODE_OK) {
                 $this->logger->debug(__METHOD__ . ': Cannot update resource. ', $a_path, $a_econtent_id);
                 throw new ilECSConnectorException('Received HTTP status code: ' . $info);
             }
         } catch (ilCurlConnectionException $exc) {
             throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $curl

ilCurlConnection ilECSConnector::$curl = null

protected

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

◆ $header_strings

array ilECSConnector::$header_strings = []

protected

Definition at line 39 of file class.ilECSConnector.php.

Referenced by getHeader().

◆ $logger

ilLogger ilECSConnector::$logger

protected

Definition at line 41 of file class.ilECSConnector.php.

◆ $path_postfix

string ilECSConnector::$path_postfix = ''

protected

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

Referenced by prepareConnection().

◆ $settings

ilECSSetting ilECSConnector::$settings = null

protected

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

Referenced by __construct(), and getServer().

◆ HEADER_COMMUNITIES

const ilECSConnector::HEADER_COMMUNITIES = 'X-EcsReceiverCommunities'

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

◆ HEADER_MEMBERSHIPS

const ilECSConnector::HEADER_MEMBERSHIPS = 'X-EcsReceiverMemberships'

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

Referenced by ilECSEnrolmentStatusConnector\addEnrolmentStatus(), ilECSCourseUrlConnector\addUrl(), ilECSObjectSettings\doAdd(), and ilECSObjectSettings\doUpdate().

◆ HTTP_CODE_CREATED

const ilECSConnector::HTTP_CODE_CREATED = 201

Definition at line 26 of file class.ilECSConnector.php.

◆ HTTP_CODE_NOT_FOUND

const ilECSConnector::HTTP_CODE_NOT_FOUND = 404

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

Referenced by ilRemoteObjectBase\handleUpdate(), and ilECSEContentDetails\loadFromServer().

◆ HTTP_CODE_OK

const ilECSConnector::HTTP_CODE_OK = 200

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

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

Services/WebServices/ECS/classes/class.ilECSConnector.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fetchEContentIdFromHeader()

◆ addAuth()

◆ addHeader()

◆ addResource()

◆ call()

◆ deleteResource()

◆ getAuth()

◆ getHeader()

◆ getMemberships()

◆ getResource()

◆ getResourceList()

◆ getServer()

◆ prepareConnection()

◆ readEventFifo()

◆ setHeader()

◆ updateResource()

Field Documentation

◆ $curl

◆ $header_strings

◆ $logger

◆ $path_postfix

◆ $settings

◆ HEADER_COMMUNITIES

◆ HEADER_MEMBERSHIPS

◆ HTTP_CODE_CREATED

◆ HTTP_CODE_NOT_FOUND

◆ HTTP_CODE_OK