ILIAS  release_4-4 Revision
ilECSResult Class Reference
+ Collaboration diagram for ilECSResult:

Public Member Functions

 __construct ($a_res, $with_headers=false, $a_type=self::RESULT_TYPE_JSON)
 Constructor. More...
 
 setHTTPCode ($a_code)
 set HTTP return code More...
 
 getHTTPCode ()
 get HTTP code More...
 
 getPlainResultString ()
 get unformated result string More...
 
 getResult ()
 get result More...
 
 setHeaders ($a_headers)
 Set header. More...
 
 getHeaders ()
 get headers More...
 

Data Fields

const RESULT_TYPE_JSON = 1
 
const RESULT_TYPE_URL_LIST = 2
 
const HEADER_ECS_SENDER = 'X-EcsSender'
 

Protected Attributes

 $log
 
 $result_string = ''
 
 $result_header = ''
 
 $http_code = ''
 
 $result
 
 $result_type
 
 $header_parsing = false
 
 $headers = array()
 
 $header_map = array()
 

Private Member Functions

 init ()
 init result (json_decode) private More...
 
 splitHeader ()
 Split header and content. More...
 
 parseHeader ()
 Parse header. More...
 
 parseUriList ($a_content)
 

Detailed Description

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 35 of file class.ilECSResult.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSResult::__construct (   $a_res,
  $with_headers = false,
  $a_type = self::RESULT_TYPE_JSON 
)

Constructor.

public

Parameters
stringresult_string
intresult type
Exceptions
ilECSConnectorException

Definition at line 63 of file class.ilECSResult.php.

References $ilLog, and init().

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  {
74  $this->header_parsing = true;
75  }
76 
77  $this->init();
78  }
init()
init result (json_decode) private
+ Here is the call graph for this function:

Member Function Documentation

◆ getHeaders()

ilECSResult::getHeaders ( )

get headers

public

Definition at line 139 of file class.ilECSResult.php.

140  {
141  return $this->headers ? $this->headers : array();
142  }

◆ getHTTPCode()

ilECSResult::getHTTPCode ( )

get HTTP code

public

Definition at line 97 of file class.ilECSResult.php.

References $http_code.

98  {
99  return $this->http_code;
100  }

◆ getPlainResultString()

ilECSResult::getPlainResultString ( )

get unformated result string

public

Definition at line 108 of file class.ilECSResult.php.

References $result_string.

Referenced by parseUriList().

109  {
110  return $this->result_string;
111  }
+ Here is the caller graph for this function:

◆ getResult()

ilECSResult::getResult ( )

get result

public

Returns
mixed JSON object, array of objects or false in case of errors.

Definition at line 120 of file class.ilECSResult.php.

References $result.

121  {
122  return $this->result;
123  }

◆ init()

ilECSResult::init ( )
private

init result (json_decode) private

Definition at line 149 of file class.ilECSResult.php.

References parseHeader(), parseUriList(), and splitHeader().

Referenced by __construct().

150  {
151  if($this->header_parsing and $this->result_string)
152  {
153  $this->splitHeader();
154  $this->parseHeader();
155  }
156 
157 
158  switch($this->result_type)
159  {
160  case self::RESULT_TYPE_JSON:
161  if($this->result_string)
162  {
163  $this->result = json_decode($this->result_string);
164  }
165  else
166  {
167  $this->result = array();
168  }
169  break;
170 
171  case self::RESULT_TYPE_URL_LIST:
172  $this->result = $this->parseUriList($this->result_string);
173  break;
174  }
175  return true;
176  }
parseHeader()
Parse header.
parseUriList($a_content)
splitHeader()
Split header and content.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseHeader()

ilECSResult::parseHeader ( )
private

Parse header.

private

Definition at line 207 of file class.ilECSResult.php.

References $location.

Referenced by init().

208  {
209  // In the moment only look for "Location:" value
210  $location_start = strpos($this->result_header,"Location:");
211  if($location_start !== false)
212  {
213  $location_start += 10;
214  $location_end = strpos($this->result_header,"\r\n",$location_start);
215 
216  $location = substr($this->result_header,$location_start,$location_end - $location_start);
217  $this->headers['Location'] = $location;
218  }
219 
220  $ecs_sender = strpos($this->result_header,self::HEADER_ECS_SENDER);
221  if($ecs_sender !== false)
222  {
223  $sender_start =+ 13;
224  $sender_end = strpos($this->result_header,"\r\n",$sender_start);
225  $sender = substr($this->result_header,$sender_start,$sender_end - $sender_start);
226 
227  $senders_arr = explode(',',$sender);
228  $this->header_map[self::HEADER_ECS_SENDER] = $senders_arr;
229  }
230  return true;
231  }
$location
Definition: buildRTE.php:44
+ Here is the caller graph for this function:

◆ parseUriList()

ilECSResult::parseUriList (   $a_content)
private
Parameters
<type>$a_content
Returns
ilECSUriList

Definition at line 238 of file class.ilECSResult.php.

References getPlainResultString().

Referenced by init().

239  {
240  include_once 'Services/WebServices/ECS/classes/class.ilECSUriList.php';
241  $list = new ilECSUriList();
242  $lines = explode("\n", $this->getPlainResultString());
243  foreach($lines as $line)
244  {
245  $line = trim($line);
246  if(!strlen($line))
247  {
248  continue;
249  }
250  $uri_parts = explode("/", $line);
251  $list->add($line, array_pop($uri_parts));
252  }
253 
254  return $list;
255  }
Presentation of ecs uril (http://...campusconnect/courselinks)
getPlainResultString()
get unformated result string
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setHeaders()

ilECSResult::setHeaders (   $a_headers)

Set header.

Parameters
array$a_headers

Definition at line 129 of file class.ilECSResult.php.

130  {
131  $this->headers = $a_headers;
132  }

◆ setHTTPCode()

ilECSResult::setHTTPCode (   $a_code)

set HTTP return code

public

Parameters
stringhttp code

Definition at line 87 of file class.ilECSResult.php.

88  {
89  $this->http_code = $a_code;
90  }

◆ splitHeader()

ilECSResult::splitHeader ( )
private

Split header and content.

private

Exceptions
ilECSConnectorException

Definition at line 185 of file class.ilECSResult.php.

Referenced by init().

186  {
187  $pos = strpos($this->result_string,"\r\n\r\n");
188  if($pos !== false)
189  {
190  $this->result_header = substr($this->result_string,0,$pos + 2);
191  $this->result_string = substr($this->result_string,$pos + 2,-1);
192  return true;
193  }
194  else
195  {
196  $this->log->write(__METHOD__.': Cannot find header entry');
197  throw new ilECSConnectorException('Cannot find header part.');
198  }
199  }
+ Here is the caller graph for this function:

Field Documentation

◆ $header_map

ilECSResult::$header_map = array()
protected

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

◆ $header_parsing

ilECSResult::$header_parsing = false
protected

Definition at line 49 of file class.ilECSResult.php.

◆ $headers

ilECSResult::$headers = array()
protected

Definition at line 51 of file class.ilECSResult.php.

◆ $http_code

ilECSResult::$http_code = ''
protected

Definition at line 46 of file class.ilECSResult.php.

Referenced by getHTTPCode().

◆ $log

ilECSResult::$log
protected

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

◆ $result

ilECSResult::$result
protected

Definition at line 47 of file class.ilECSResult.php.

Referenced by getResult().

◆ $result_header

ilECSResult::$result_header = ''
protected

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

◆ $result_string

ilECSResult::$result_string = ''
protected

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

Referenced by getPlainResultString().

◆ $result_type

ilECSResult::$result_type
protected

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

◆ HEADER_ECS_SENDER

const ilECSResult::HEADER_ECS_SENDER = 'X-EcsSender'

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

◆ RESULT_TYPE_JSON

const ilECSResult::RESULT_TYPE_JSON = 1

Definition at line 37 of file class.ilECSResult.php.

◆ RESULT_TYPE_URL_LIST

const ilECSResult::RESULT_TYPE_URL_LIST = 2

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