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

string	result_string
int	result type

Exceptions

ilECSConnectorException

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

References $a_type, $DIC, $ilLog, and init().

    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        $this->log = $ilLog;
        
        $this->result_string = $a_res;
        $this->result_type = $a_type;
        
        if ($with_headers) {
            $this->header_parsing = true;
        }
    
        $this->init();
    }

Here is the call graph for this function:

Member Function Documentation

getHeaders()

ilECSResult::getHeaders

(

)

get headers

public

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

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

getHTTPCode()

ilECSResult::getHTTPCode

(

)

get HTTP code

public

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

References $http_code.

    {
        return $this->http_code;
    }

getPlainResultString()

ilECSResult::getPlainResultString

(

)

get unformated result string

public

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

References $result_string.

Referenced by parseUriList().

    {
        return $this->result_string;
    }

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 121 of file class.ilECSResult.php.

References $result.

    {
        return $this->result;
    }

init()

ilECSResult::init ( )

private

init result (json_decode) private

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

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

Referenced by __construct().

    {
        if ($this->header_parsing and $this->result_string) {
            $this->splitHeader();
            $this->parseHeader();
        }

        
        switch ($this->result_type) {
            case self::RESULT_TYPE_JSON:
                if ($this->result_string) {
                    $this->result = json_decode($this->result_string);
                } else {
                    $this->result = array();
                }
                break;

            case self::RESULT_TYPE_URL_LIST:
                $this->result = $this->parseUriList($this->result_string);
                break;
        }
        return true;
    }

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 200 of file class.ilECSResult.php.

References $location.

Referenced by init().

    {
        // In the moment only look for "Location:" value
        $location_start = strpos($this->result_header, "Location:");
        if ($location_start !== false) {
            $location_start += 10;
            $location_end = strpos($this->result_header, "\r\n", $location_start);
            
            $location = substr($this->result_header, $location_start, $location_end - $location_start);
            $this->headers['Location'] = $location;
        }
        
        $ecs_sender = strpos($this->result_header, self::HEADER_ECS_SENDER);
        if ($ecs_sender !== false) {
            $sender_start = +13;
            $sender_end = strpos($this->result_header, "\r\n", $sender_start);
            $sender = substr($this->result_header, $sender_start, $sender_end - $sender_start);
            
            $senders_arr = explode(',', $sender);
            $this->header_map[self::HEADER_ECS_SENDER] = $senders_arr;
        }
        return true;
    }

Here is the caller graph for this function:

parseUriList()

ilECSResult::parseUriList (   $a_content )

private

Parameters

<type>

$a_content

Returns

ilECSUriList

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

References $list, and getPlainResultString().

Referenced by init().

    {
        include_once 'Services/WebServices/ECS/classes/class.ilECSUriList.php';
        $list = new ilECSUriList();
        $lines = explode("\n", $this->getPlainResultString());
        foreach ($lines as $line) {
            $line = trim($line);
            if (!strlen($line)) {
                continue;
            }
            $uri_parts = explode("/", $line);
            $list->add($line, array_pop($uri_parts));
        }

        return $list;
    }

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 130 of file class.ilECSResult.php.

    {
        $this->headers = $a_headers;
    }

setHTTPCode()

ilECSResult::setHTTPCode

(

$a_code

)

set HTTP return code

public

Parameters

string

http code

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

    {
        $this->http_code = $a_code;
    }

splitHeader()

ilECSResult::splitHeader ( )

private

Split header and content.

private

Exceptions

ilECSConnectorException

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

Referenced by init().

    {
        $pos = strpos($this->result_string, "\r\n\r\n");
        if ($pos !== false) {
            $this->result_header = substr($this->result_string, 0, $pos + 2);
            $this->result_string = substr($this->result_string, $pos + 2, -1);
            return true;
        } else {
            $this->log->write(__METHOD__ . ': Cannot find header entry');
            throw new ilECSConnectorException('Cannot find header part.');
        }
    }

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

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

Referenced by ilECSDirectoryTreeConnector\getDirectoryTrees(), and ilECSConnector\getResourceList().

---

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

• Services/WebServices/ECS/classes/class.ilECSResult.php