ilECSEnrolmentStatusConnector Class Reference

Connector for course member ressource. More...

Inheritance diagram for ilECSEnrolmentStatusConnector:

Collaboration diagram for ilECSEnrolmentStatusConnector:

Public Member Functions
	getEnrolmentStatus ($a_enrole_id=0, $a_details=false)
	Get single directory tree. More...
	addEnrolmentStatus (ilECSEnrolmentStatus $enrolment, $a_target_mid)
	Add new enrolment status. More...
Public Member Functions inherited from ilECSConnector
	__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)

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...
Protected Attributes inherited from ilECSConnector
string	$path_postfix = ''
ilECSSetting	$settings = null
ilCurlConnection	$curl = null
array	$header_strings = []
ilLogger	$logger

Detailed Description

Connector for course member ressource.

Author

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

Definition at line 25 of file class.ilECSEnrolmentStatusConnector.php.

Member Function Documentation

addEnrolmentStatus()

ilECSEnrolmentStatusConnector::addEnrolmentStatus	(	ilECSEnrolmentStatus	$enrolment,
			$a_target_mid
	)

Add new enrolment status.

Definition at line 75 of file class.ilECSEnrolmentStatusConnector.php.

    {
        $this->logger->info('Add new enrolment status');
 
        $this->path_postfix = '/campusconnect/member_status';
 
        try {
            $this->prepareConnection();
 
            $this->addHeader('Content-Type', 'application/json');
            $this->addHeader('Accept', 'application/json');
            $this->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, (string) $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, json_encode($enrolment, JSON_THROW_ON_ERROR));
            $ret = $this->call();
 
            $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
 
            $this->logger->debug(': Checking HTTP status...');
            if ($info !== self::HTTP_CODE_CREATED) {
                $this->logger->debug(': Cannot create auth resource, did not receive HTTP 201. ');
                $this->logger->debug(': POST was: ' . print_r($enrolment, true));
                $this->logger->debug(': HTTP code: ' . $info);
                throw new ilECSConnectorException('Received HTTP status code: ' . $info);
            }
            $this->logger->debug(': ... got HTTP 201 (created)');
 
            $result = new ilECSResult($ret);
            $enrolment_res = $result->getResult();
 
            $this->logger->debug(': ... Received result: ' . print_r($enrolment_res, true));
 
            return $enrolment_res;
        } catch (ilCurlConnectionException $exc) {
            throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
        }
    }

References $info, ilECSConnector\addHeader(), ilECSConnector\call(), ilECSConnector\getHeader(), ilECSConnector\HEADER_MEMBERSHIPS, ILIAS\Repository\logger(), and ilECSConnector\prepareConnection().

Here is the call graph for this function:

getEnrolmentStatus()

ilECSEnrolmentStatusConnector::getEnrolmentStatus	(		$a_enrole_id = 0,
			$a_details = false
	)

Get single directory tree.

Returns

ilECSEContentDetails|ilECSEnrolmentStatus object of EContentDetails or object of ECSEnrolmentStatus

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

    {
        if ($a_enrole_id) {
            $this->path_postfix = '/campusconnect/member_status/' . (int) $a_enrole_id;
        }
        if ($a_details && $a_enrole_id) {
            $this->path_postfix .= '/details';
        }
 
        try {
            $this->prepareConnection();
            $this->setHeader(array());
            if ($a_details) {
                $this->addHeader('Accept', 'application/json');
            }
            $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
            $res = $this->call();
 
            if (strpos($res, 'http') === 0) {
                $json = file_get_contents($res);
                $ecs_result = new ilECSResult($json);
            } else {
                $ecs_result = new ilECSResult($res);
            }
 
            // Return ECSEContentDetails for details switch
            if ($a_details) {
                $details = new ilECSEContentDetails();
                $this->logger->debug(print_r($res, true));
                $details->loadFromJson($ecs_result->getResult());
                return $details;
            }
            $enrolment = new ilECSEnrolmentStatus();
            $enrolment->loadFromJson($ecs_result->getResult());
            return $enrolment;
        } catch (ilCurlConnectionException $e) {
            throw new ilECSConnectorException('Error calling ECS service: ' . $e->getMessage());
        }
    }

References Vendor\Package\$e, $res, ilECSConnector\addHeader(), ilECSConnector\call(), ilECSConnector\getHeader(), ILIAS\Repository\int(), ILIAS\Repository\logger(), ilECSConnector\prepareConnection(), and ilECSConnector\setHeader().

Here is the call graph for this function:

---

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

• components/ILIAS/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatusConnector.php