Inheritance diagram for ilECSConnector:

Collaboration diagram for ilECSConnector:

Public Member Functions
	__construct (ilECSSetting $settings=null)
	Constructor. More...

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

	getHeader ()

	setHeader ($a_header_strings)

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

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

	getAuth ($a_hash, $a_details_only=FALSE)
	get auth resource More...

	getEventQueues ()
	get event queue More...

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

	getResourceList ($a_path)

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

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

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

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

	getMemberships ($a_mid=0)
	@access public More...

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

Static Protected Member Functions
static	_fetchEContentIdFromHeader ($a_header)
	fetch new econtent id from location header More...

Protected Attributes
	$path_postfix = ''

	$settings

	$header_strings = array()

Detailed Description

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

Version: $Id$

@ilCtrl_Calls

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

Constructor & Destructor Documentation

◆ __construct()

ilECSConnector::__construct ( ilECSSetting $settings = null )

Constructor.

@access public

Parameters

Reimplemented in ilECSEnrolmentStatusConnector, ilECSCourseConnector, ilECSCourseMemberConnector, ilECSCourseUrlConnector, and ilECSDirectoryTreeConnector.

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

        {
                if($settings)
                {
                        $this->settings = $settings;
                }
                else
                {
                        $GLOBALS['ilLog']->write(__METHOD__.': Using deprecated call');
                        $GLOBALS['ilLog']->logStack();
                }
        }

References $GLOBALS, and $settings.

Member Function Documentation

◆ _fetchEContentIdFromHeader()

static ilECSConnector::_fetchEContentIdFromHeader ( $a_header )

staticprotected

fetch new econtent id from location header

@access public

Parameters

array header array

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

        {
                global $ilLog;
                
                if(!isset($a_header['Location']))
                {
                        return false;
                }
                $end_path = strrpos($a_header['Location'],"/");
                
                if($end_path === false)
                {
                        $ilLog->write(__METHOD__.': Cannot find path seperator.');
                        return false;
                }
                $econtent_id = substr($a_header['Location'],$end_path + 1);
                $ilLog->write(__METHOD__.': Received EContentId '.$econtent_id);
                return (int) $econtent_id;
        }       

References $ilLog.

Referenced by addResource().

Here is the caller graph for this function:

◆ addAuth()

ilECSConnector::addAuth	(	$a_post,
		$a_target_mid
	)

Add auth resource.

@access public

Parameters

string post data

Returns: int new econtent id

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                $ilLog->write(__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(ilECSConnector::HEADER_MEMBERSHIPS, $a_target_mid);
                        #$this->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, 1);
 
                        $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);
        
                        $ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_CREATED)
                        {
                                $ilLog->write(__METHOD__.': Cannot create auth resource, did not receive HTTP 201. ');
                                $ilLog->write(__METHOD__.': POST was: '.$a_post);
                                $ilLog->write(__METHOD__.': HTTP code: '.$info);
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        $ilLog->write(__METHOD__.': ... got HTTP 201 (created)');
                        $ilLog->write(__METHOD__.': POST was: '.$a_post);
 
                        $result = new ilECSResult($ret);
                        $auth = $result->getResult();
 
                        $ilLog->write(__METHOD__.': ... got hash: '.$auth->hash);
 
                        return $auth->hash;
                }
                catch(ilCurlConnectionException $exc)
                {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
        }

References $auth, $ilLog, $info, $result, $ret, addHeader(), call(), getHeader(), HEADER_MEMBERSHIPS, and prepareConnection().

Here is the call graph for this function:

◆ addHeader()

ilECSConnector::addHeader	(	$a_name,
		$a_value
	)

Add Header.

Parameters

string	$a_name
string	$a_value

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

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

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

Here is the caller graph for this function:

◆ addResource()

ilECSConnector::addResource	(	$a_path,
		$a_post
	)

Add resource.

@access public

Parameters

string	resource "path"
string	post data

Returns: int new econtent id

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                $ilLog->write(__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);
                        $res = $this->call();
                        
                        $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
        
                        $ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_CREATED)
                        {
                                $ilLog->write(__METHOD__.': Cannot create econtent, did not receive HTTP 201. ');
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        $ilLog->write(__METHOD__.': ... got HTTP 201 (created)');                       
 
                        $eid =  self::_fetchEContentIdFromHeader($this->curl->getResponseHeaderArray());
                        return $eid;
                }
                catch(ilCurlConnectionException $exc)
                {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
        }

References $ilLog, $info, $res, _fetchEContentIdFromHeader(), addHeader(), call(), getHeader(), and prepareConnection().

Here is the call graph for this function:

◆ call()

ilECSConnector::call ( )

protected

call peer

@access private

Exceptions

ilCurlConnectionException

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

        {
                try
                {
                        $res = $this->curl->exec();
                        return $res;
                }               
                catch(ilCurlConnectionException $exc)
                {
                        throw($exc);
                }
        }

References $res.

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

Here is the caller graph for this function:

◆ deleteResource()

ilECSConnector::deleteResource	(	$a_path,
		$a_econtent_id
	)

Delete resource.

@access public

Parameters

string	resource "path"
string	econtent id

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                $ilLog->write(__METHOD__.': Delete resource with id '.$a_econtent_id);
 
                $this->path_postfix = $a_path;
                
                if($a_econtent_id)
                {
                        $this->path_postfix .= ('/'.(int) $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();
                        return new ilECSResult($res);
                }
                catch(ilCurlConnectionException $exc)
                {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
                
        }

References $ilLog, $res, call(), and prepareConnection().

Here is the call graph for this function:

◆ getAuth()

ilECSConnector::getAuth	(	$a_hash,
		$a_details_only = `FALSE`
	)

get auth resource

@access public

Parameters

auth	hash (transfered via GET)

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                if(!strlen($a_hash))
                {
                        $ilLog->write(__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);
                        
                        $ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_OK)
                        {
                                $ilLog->write(__METHOD__.': Cannot get auth resource, did not receive HTTP 200. ');
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        $ilLog->write(__METHOD__.': ... got HTTP 200 (ok)');
                        
                        $ecs_result = new ilECSResult($res);
                        // Return ECSEContentDetails for details switch
                        if($a_details_only)
                        {
                                include_once './Services/WebServices/ECS/classes/class.ilECSEContentDetails.php';
                                $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());
                }
        }

References $ilLog, $info, $res, call(), and prepareConnection().

Here is the call graph for this function:

◆ getEventQueues()

ilECSConnector::getEventQueues ( )

get event queue

@access public

Exceptions

ilECSConnectorException

Deprecated:

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

        {
                global $ilLog;
                
                $this->path_postfix = '/eventqueues';
 
                try 
                {
                        $this->prepareConnection();
                        
                        $res = $this->call();
                        $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
        
                        $ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_OK)
                        {
                                $ilLog->write(__METHOD__.': Cannot get event queue, did not receive HTTP 200. ');
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        $ilLog->write(__METHOD__.': ... got HTTP 200 (ok)');                    
                        return new ilECSResult($res);
                }
                catch(ilCurlConnectionException $exc)
                {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
        }

References $ilLog, $info, $res, call(), and prepareConnection().

Here is the call graph for this function:

◆ getHeader()

ilECSConnector::getHeader ( )

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

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

References $header_strings.

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

Here is the caller graph for this function:

◆ getMemberships()

ilECSConnector::getMemberships ( $a_mid = 0 )

@access public

Parameters

int	membership id

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                $ilLog->write(__METHOD__.': Get existing memberships');
 
                $this->path_postfix = '/sys/memberships';
                if($a_mid)
                {
                        $ilLog->write(__METHOD__.': Read membership with id: '.$a_mid);
                        $this->path_postfix .= ('/'.(int) $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)
                        {
                                $ilLog->write(__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());
                }
        }

References $ilLog, $info, $res, call(), and prepareConnection().

Here is the call graph for this function:

◆ getResource()

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

Get resources from ECS server.

@access public

Parameters

string	resource "path"
int	e-content id

Returns: object ECSResult

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                if($a_econtent_id)
                {
                        $ilLog->write(__METHOD__.': Get resource with ID: '.$a_econtent_id);
                }
                else
                {
                        $ilLog->write(__METHOD__.': Get all resources ...');
                }
                
                $this->path_postfix = $a_path;
                if($a_econtent_id)
                {
                        $this->path_postfix .= ('/'.(int) $a_econtent_id);
                }
                if($a_details_only)
                {
                        $this->path_postfix .= ('/details');
                }
                
                try 
                {
                        $this->prepareConnection();
                        $res = $this->call();
 
                        // Checking status code
                        $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
                        $ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_OK)
                        {
                                $ilLog->write(__METHOD__.': Cannot get ressource, did not receive HTTP 200. ');
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        $ilLog->write(__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());
                }
        }

References $ilLog, $info, $res, $result, call(), and prepareConnection().

Here is the call graph for this function:

◆ getResourceList()

ilECSConnector::getResourceList ( $a_path )

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

        {
                global $ilLog;
 
                $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);
                        $ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_OK)
                        {
                                $ilLog->write(__METHOD__.': Cannot get ressource list, did not receive HTTP 200. ');
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        $ilLog->write(__METHOD__.': ... got HTTP 200 (ok)');
 
                        return new ilECSResult($res,false,  ilECSResult::RESULT_TYPE_URL_LIST);
 
                }
                catch(ilCurlConnectionException $exc) {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
        }

References $ilLog, $info, $res, call(), getHeader(), prepareConnection(), and ilECSResult\RESULT_TYPE_URL_LIST.

Here is the call graph for this function:

◆ getServer()

ilECSConnector::getServer ( )

Get current server setting.

Returns: ilECSSetting

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

        {
                return $this->settings;
        }

References $settings.

Referenced by prepareConnection().

Here is the caller graph for this function:

◆ prepareConnection()

ilECSConnector::prepareConnection ( )

protected

prepare connection

@access private

Exceptions

ilCurlConnectionException

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

        {
 
                try
                {
                        $this->curl = new ilCurlConnection($this->settings->getServerURI().$this->path_postfix);
                        $this->curl->init();
                        $this->curl->setOpt(CURLOPT_HTTPHEADER,array(0 => 'Accept: application/json'));
                        $this->curl->setOpt(CURLOPT_RETURNTRANSFER,1);
                        $this->curl->setOpt(CURLOPT_VERBOSE,1);
                        $this->curl->setOpt(CURLOPT_TIMEOUT_MS,2000);
 
                        switch($this->getServer()->getAuthType())
                        {
                                case ilECSSetting::AUTH_APACHE:
                                        $this->curl->setOpt(CURLOPT_SSL_VERIFYPEER,0);
                                        #$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);
                }
        }

References ilECSSetting\AUTH_APACHE, ilECSSetting\AUTH_CERTIFICATE, and getServer().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEventFifo()

ilECSConnector::readEventFifo ( $a_delete = false )

Read event fifo.

Parameters

bool	set to true for deleting the current element

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
 
                $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);
                        #$ilLog->write(__METHOD__.': Checking HTTP status...');
                        if($info != self::HTTP_CODE_OK)
                        {
                                $ilLog->write(__METHOD__.': Cannot read event fifo, did not receive HTTP 200. ');
                                throw new ilECSConnectorException('Received HTTP status code: '.$info);
                        }
                        #$ilLog->write(__METHOD__.': ... got HTTP 200 (ok)');
 
                        $result = new ilECSResult($res);
                        
                        #$GLOBALS['ilLog']->write(__METHOD__.':------------------------------------- FIFO content'. print_r($result,true));
                        
                        return $result;
                }
                catch(ilCurlConnectionException $exc)
                {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
        }

References $ilLog, $info, $res, $result, addHeader(), call(), and prepareConnection().

Here is the call graph for this function:

◆ setHeader()

ilECSConnector::setHeader ( $a_header_strings )

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

        {
                $this->header_strings = $a_header_strings;
        }

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

Here is the caller graph for this function:

◆ updateResource()

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

update resource

@access public

Parameters

string	resource "path"
int	econtent id
string	post content

Exceptions

ilECSConnectorException

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

        {
                global $ilLog;
                
                $ilLog->write(__METHOD__.': Update resource with id '.$a_econtent_id);
                
                $this->path_postfix = $a_path;
                
                if($a_econtent_id)
                {
                        $this->path_postfix .= ('/'.(int) $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->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
                        $this->curl->setOpt(CURLOPT_HEADER,true);
                        $this->curl->setOpt(CURLOPT_PUT,true);
 
                        $tempfile = ilUtil::ilTempnam();
                        $ilLog->write(__METHOD__.': Created new tempfile: '.$tempfile);
 
                        $fp = fopen($tempfile,'w');
                        fwrite($fp,$a_post_string);
                        fclose($fp);
                        
                        $this->curl->setOpt(CURLOPT_UPLOAD,true);
                        $this->curl->setOpt(CURLOPT_INFILESIZE,filesize($tempfile));
                        $fp = fopen($tempfile,'r');
                        $this->curl->setOpt(CURLOPT_INFILE,$fp);
                        
                        $res = $this->call();
                        
                        fclose($fp);
                        unlink($tempfile);
                        
                        return new ilECSResult($res);
                }
                catch(ilCurlConnectionException $exc)
                {
                        throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
                }
        }

References $ilLog, $res, addHeader(), call(), getHeader(), ilUtil\ilTempnam(), and prepareConnection().

Here is the call graph for this function:

Field Documentation

◆ $header_strings

ilECSConnector::$header_strings = array()

protected

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

Referenced by getHeader().

◆ $path_postfix

ilECSConnector::$path_postfix = ''

protected

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

◆ $settings

ilECSConnector::$settings

protected

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

Referenced by __construct(), ilECSEnrolmentStatusConnector\__construct(), ilECSCourseConnector\__construct(), ilECSCourseMemberConnector\__construct(), ilECSCourseUrlConnector\__construct(), ilECSDirectoryTreeConnector\__construct(), and getServer().

◆ HEADER_COMMUNITIES

const ilECSConnector::HEADER_COMMUNITIES = 'X-EcsReceiverCommunities'

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

◆ HEADER_MEMBERSHIPS

const ilECSConnector::HEADER_MEMBERSHIPS = 'X-EcsReceiverMemberships'

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

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

◆ HTTP_CODE_CREATED

const ilECSConnector::HTTP_CODE_CREATED = 201

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

◆ HTTP_CODE_NOT_FOUND

const ilECSConnector::HTTP_CODE_NOT_FOUND = 404

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

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

◆ HTTP_CODE_OK

const ilECSConnector::HTTP_CODE_OK = 200

Definition at line 41 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

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fetchEContentIdFromHeader()

◆ addAuth()

◆ addHeader()

◆ addResource()

◆ call()

◆ deleteResource()

◆ getAuth()

◆ getEventQueues()

◆ getHeader()

◆ getMemberships()

◆ getResource()

◆ getResourceList()

◆ getServer()

◆ prepareConnection()

◆ readEventFifo()

◆ setHeader()

◆ updateResource()

Field Documentation

◆ $header_strings

◆ $path_postfix

◆ $settings

◆ HEADER_COMMUNITIES

◆ HEADER_MEMBERSHIPS

◆ HTTP_CODE_CREATED

◆ HTTP_CODE_NOT_FOUND

◆ HTTP_CODE_OK