ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilECSEnrolmentStatusConnector Class Reference

Connector for course member ressource. More...

+ Inheritance diagram for ilECSEnrolmentStatusConnector:
+ Collaboration diagram for ilECSEnrolmentStatusConnector:

Public Member Functions

 __construct (ilECSSetting $settings=null)
 Constructor. More...
 
 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)
 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 course member ressource.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilECSEnrolmentStatusConnector::__construct ( ilECSSetting  $settings = null)

Constructor.

Parameters
ilECSSetting$settings

Reimplemented from ilECSConnector.

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

22 {
23 parent::__construct($settings);
24 }

References ilECSConnector\$settings.

Member Function Documentation

◆ addEnrolmentStatus()

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

Add new enrolment status.

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

95 {
96 global $ilLog;
97
98 $ilLog->write(__METHOD__.': Add new enrolment status');
99
100 $this->path_postfix = '/campusconnect/member_status';
101
102 try
103 {
104 $this->prepareConnection();
105
106 $this->addHeader('Content-Type', 'application/json');
107 $this->addHeader('Accept', 'application/json');
108 $this->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, $a_target_mid);
109 #$this->addHeader(ilECSConnector::HEADER_MEMBERSHIPS, 1);
110
111 $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
112 $this->curl->setOpt(CURLOPT_POST,true);
113 $this->curl->setOpt(CURLOPT_POSTFIELDS,json_encode($enrolment));
114 $ret = $this->call();
115
116 $info = $this->curl->getInfo(CURLINFO_HTTP_CODE);
117
118 $ilLog->write(__METHOD__.': Checking HTTP status...');
119 if($info != self::HTTP_CODE_CREATED)
120 {
121 $ilLog->write(__METHOD__.': Cannot create auth resource, did not receive HTTP 201. ');
122 $ilLog->write(__METHOD__.': POST was: '.print_r($enrolment,TRUE));
123 $ilLog->write(__METHOD__.': HTTP code: '.$info);
124 throw new ilECSConnectorException('Received HTTP status code: '.$info);
125 }
126 $ilLog->write(__METHOD__.': ... got HTTP 201 (created)');
127
128 $result = new ilECSResult($ret);
129 $enrolment_res = $result->getResult();
130
131 $ilLog->write(__METHOD__.': ... Received result: '.print_r($enrolment_res,TRUE));
132
133 return $enrolment_res;
134 }
135 catch(ilCurlConnectionException $exc)
136 {
137 throw new ilECSConnectorException('Error calling ECS service: '.$exc->getMessage());
138 }
139
140 }
$result
addHeader($a_name, $a_value)
Add Header.
prepareConnection()
prepare connection
$info
Definition: example_052.php:80

References $ilLog, $info, $result, $ret, ilECSConnector\addHeader(), ilECSConnector\call(), ilECSConnector\getHeader(), ilECSConnector\HEADER_MEMBERSHIPS, 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
mixed object of EContentDetails or object of ECSEnrolmentStatus

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

32 {
33 if($a_enrole_id)
34 {
35 $this->path_postfix = '/campusconnect/member_status/'. (int) $a_enrole_id;
36 }
37 if($a_details and $a_enrole_id)
38 {
39 $this->path_postfix .= '/details';
40 }
41
42 try {
43
44 $this->prepareConnection();
45 $this->setHeader(array());
46 if($a_details)
47 {
48 $this->addHeader('Accept', 'application/json');
49 }
50 else
51 {
52 #$this->addHeader('Accept', 'text/uri-list');
53 }
54 $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
55 $res = $this->call();
56
57 if(substr($res, 0, 4) == 'http')
58 {
59 $json = file_get_contents($res);
60 $ecs_result = new ilECSResult($json);
61 }
62 else
63 {
64 $ecs_result = new ilECSResult($res);
65 }
66
67 // Return ECSEContentDetails for details switch
68 if($a_details)
69 {
70 include_once './Services/WebServices/ECS/classes/class.ilECSEContentDetails.php';
71 $details = new ilECSEContentDetails();
72 $GLOBALS['ilLog']->write(print_r($res,true));
73 $details->loadFromJson($ecs_result->getResult());
74 return $details;
75 }
76 else
77 {
78 include_once './Services/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php';
79 $enrolment = new ilECSEnrolmentStatus();
80 $enrolment->loadFromJson($ecs_result->getResult());
81 return $enrolment;
82 }
83 }
85 {
86 throw new ilECSConnectorException('Error calling ECS service: '.$e->getMessage());
87 }
88 }
setHeader($a_header_strings)
Presentation of ecs content details (http://...campusconnect/courselinks/id/details)
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276

References $GLOBALS, $res, ilECSConnector\addHeader(), ilECSConnector\call(), ilECSConnector\getHeader(), ilECSConnector\prepareConnection(), and ilECSConnector\setHeader().

+ Here is the call graph for this function:

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