ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
class.ilECSResult.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2006 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
24include_once('./Services/WebServices/ECS/classes/class.ilECSConnectorException.php');
25
36{
39
40 const HEADER_ECS_SENDER = 'X-EcsSender';
41
42 protected $log;
43
44 protected $result_string = '';
45 protected $result_header = '';
46 protected $http_code = '';
47 protected $result;
48 protected $result_type;
49 protected $header_parsing = false;
50
51 protected $headers = array();
52 protected $header_map = array();
53
63 public function __construct($a_res, $with_headers = false, $a_type = self::RESULT_TYPE_JSON)
64 {
65 global $ilLog;
66
67 $this->log = $ilLog;
68
69 $this->result_string = $a_res;
70 $this->result_type = $a_type;
71
72 if ($with_headers) {
73 $this->header_parsing = true;
74 }
75
76 $this->init();
77 }
78
86 public function setHTTPCode($a_code)
87 {
88 $this->http_code = $a_code;
89 }
90
96 public function getHTTPCode()
97 {
98 return $this->http_code;
99 }
100
107 public function getPlainResultString()
108 {
110 }
111
119 public function getResult()
120 {
121 return $this->result;
122 }
123
128 public function setHeaders($a_headers)
129 {
130 $this->headers = $a_headers;
131 }
132
138 public function getHeaders()
139 {
140 return $this->headers ? $this->headers : array();
141 }
142
148 private function init()
149 {
150 if ($this->header_parsing and $this->result_string) {
151 $this->splitHeader();
152 $this->parseHeader();
153 }
154
155
156 switch ($this->result_type) {
158 if ($this->result_string) {
159 $this->result = json_decode($this->result_string);
160 } else {
161 $this->result = array();
162 }
163 break;
164
166 $this->result = $this->parseUriList($this->result_string);
167 break;
168 }
169 return true;
170 }
171
179 private function splitHeader()
180 {
181 $pos = strpos($this->result_string, "\r\n\r\n");
182 if ($pos !== false) {
183 $this->result_header = substr($this->result_string, 0, $pos + 2);
184 $this->result_string = substr($this->result_string, $pos + 2, -1);
185 return true;
186 } else {
187 $this->log->write(__METHOD__ . ': Cannot find header entry');
188 throw new ilECSConnectorException('Cannot find header part.');
189 }
190 }
191
198 private function parseHeader()
199 {
200 // In the moment only look for "Location:" value
201 $location_start = strpos($this->result_header, "Location:");
202 if ($location_start !== false) {
203 $location_start += 10;
204 $location_end = strpos($this->result_header, "\r\n", $location_start);
205
206 $location = substr($this->result_header, $location_start, $location_end - $location_start);
207 $this->headers['Location'] = $location;
208 }
209
210 $ecs_sender = strpos($this->result_header, self::HEADER_ECS_SENDER);
211 if ($ecs_sender !== false) {
212 $sender_start =+13;
213 $sender_end = strpos($this->result_header, "\r\n", $sender_start);
214 $sender = substr($this->result_header, $sender_start, $sender_end - $sender_start);
215
216 $senders_arr = explode(',', $sender);
217 $this->header_map[self::HEADER_ECS_SENDER] = $senders_arr;
218 }
219 return true;
220 }
221
227 private function parseUriList($a_content)
228 {
229 include_once 'Services/WebServices/ECS/classes/class.ilECSUriList.php';
230 $list = new ilECSUriList();
231 $lines = explode("\n", $this->getPlainResultString());
232 foreach ($lines as $line) {
233 $line = trim($line);
234 if (!strlen($line)) {
235 continue;
236 }
237 $uri_parts = explode("/", $line);
238 $list->add($line, array_pop($uri_parts));
239 }
240
241 return $list;
242 }
243}
$location
Definition: buildRTE.php:44
An exception for terminatinating execution or to throw for unit testing.
setHeaders($a_headers)
Set header.
getHeaders()
get headers
getResult()
get result
const RESULT_TYPE_URL_LIST
parseUriList($a_content)
setHTTPCode($a_code)
set HTTP return code
getHTTPCode()
get HTTP code
init()
init result (json_decode) @access private
getPlainResultString()
get unformated result string
splitHeader()
Split header and content.
parseHeader()
Parse header.
__construct($a_res, $with_headers=false, $a_type=self::RESULT_TYPE_JSON)
Constructor.
Presentation of ecs uril (http://...campusconnect/courselinks)
if(isset($_REQUEST['delete'])) $list
Definition: registry.php:41
$a_content
Definition: workflow.php:93
$a_type
Definition: workflow.php:92