ilECSCourseUrlConnector Class Reference

Connector for writing ecs course urls. More...

Inheritance diagram for ilECSCourseUrlConnector:

Collaboration diagram for ilECSCourseUrlConnector:

Public Member Functions
	__construct (ilECSSetting $settings=null)
	Constructor. More...
	addUrl (ilECSCourseUrl $url, $a_target_mid)
	Send url of newly created courses to ecs. More...
Public Member Functions inherited from ilECSConnector
	__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...

Additional Inherited Members
Data Fields inherited from ilECSConnector
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 inherited from ilECSConnector
	prepareConnection ()
	prepare connection More...
	call ()
	call peer More...
Static Protected Member Functions inherited from ilECSConnector
static	_fetchEContentIdFromHeader ($a_header)
	fetch new econtent id from location header More...
Protected Attributes inherited from ilECSConnector
	$path_postfix = ''
	$settings
	$header_strings = array()

Detailed Description

Connector for writing ecs course urls.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e $Id$

Definition at line 13 of file class.ilECSCourseUrlConnector.php.

Constructor & Destructor Documentation

__construct()

ilECSCourseUrlConnector::__construct

(

ilECSSetting

$settings = null

)

Constructor.

Parameters

ilECSSetting

$settings

Reimplemented from ilECSConnector.

Definition at line 19 of file class.ilECSCourseUrlConnector.php.

    {
        parent::__construct($settings);
    }

References ilECSConnector\$settings.

Member Function Documentation

addUrl()

ilECSCourseUrlConnector::addUrl	(	ilECSCourseUrl	$url,
			$a_target_mid
	)

Send url of newly created courses to ecs.

Returns

type

Exceptions

ilECSConnectorException

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

    {
        global $ilLog;
        
        $ilLog->write(__METHOD__ . ': Add new course url ...');
 
        $this->path_postfix = '/campusconnect/course_urls';
        
        try {
            $this->prepareConnection();
 
            $this->addHeader('Content-Type', 'application/json');
            $this->addHeader('Accept', 'application/json');
            $this->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, $a_target_mid);
 
            $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
            $this->curl->setOpt(CURLOPT_POST, true);
            $this->curl->setOpt(CURLOPT_POSTFIELDS, json_encode($url));
            
            $GLOBALS['ilLog']->write(__METHOD__ . ': Sending url ' . print_r(json_encode($url), true));
            
            $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 course url ressource, did not receive HTTP 201. ');
                $ilLog->write(__METHOD__ . ': POST was: ' . json_encode($url));
                $ilLog->write(__METHOD__ . ': HTTP code: ' . $info);
                throw new ilECSConnectorException('Received HTTP status code: ' . $info);
            }
            $ilLog->write(__METHOD__ . ': ... got HTTP 201 (created)');
        } catch (ilCurlConnectionException $exc) {
            throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
        }
    }

References $GLOBALS, $ilLog, $info, $ret, $url, ilECSConnector\addHeader(), ilECSConnector\call(), ilECSConnector\getHeader(), ilECSConnector\HEADER_MEMBERSHIPS, and ilECSConnector\prepareConnection().

Here is the call graph for this function:

---

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

• Services/WebServices/ECS/classes/Course/class.ilECSCourseUrlConnector.php