ilECSResult Class Reference

Collaboration diagram for ilECSResult:

Public Member Functions
	__construct (string $a_res, int $a_type=self::RESULT_TYPE_JSON)
	Constructor. More...
	setHTTPCode (int $a_code)
	set HTTP return code More...
	getHTTPCode ()
	get HTTP code More...
	getResult ()
	get result More...
	getResultType ()
	setHeaders (array $a_headers)
	Set header. More...
	getHeaders ()
	get headers More...

Data Fields
const	RESULT_TYPE_JSON = 1
const	RESULT_TYPE_URL_LIST = 2

Private Member Functions
	init (string $result_string, int $result_type)
	init result (json_decode) More...
	parseUriList (string $a_content)

Private Attributes
int	$http_code = 0
int	$result_type
	$result
array	$headers = array()

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilECSResult::__construct	(	string	$a_res,
		int	$a_type = self::RESULT_TYPE_JSON
	)

Constructor.

@access public

Parameters

string	result_string
int	result type

Exceptions

ilECSConnectorException

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

    {
        $this->result_type = $a_type;
 
        $this->init($a_res, $a_type);
    }

References init().

Here is the call graph for this function:

Member Function Documentation

getHeaders()

ilECSResult::getHeaders

(

)

get headers

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

                                : array
    {
        return $this->headers ?: [];
    }

getHTTPCode()

ilECSResult::getHTTPCode

(

)

get HTTP code

@access public

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

                                 : int
    {
        return $this->http_code;
    }

References $http_code.

getResult()

ilECSResult::getResult

(

)

get result

Returns

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

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

    {
        return $this->result;
    }

References $result.

getResultType()

ilECSResult::getResultType

(

)

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

                                   : int
    {
        return $this->result_type;
    }

References $result_type.

init()

ilECSResult::init ( string  $result_string, int  $result_type  )

private

init result (json_decode)

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

                                                                  : void
    {
        switch ($result_type) {
            case self::RESULT_TYPE_JSON:
                if ($result_string) {
                    $this->result = json_decode($result_string, false, 512, JSON_THROW_ON_ERROR);
                } else {
                    $this->result = [];
                }
                break;
 
            case self::RESULT_TYPE_URL_LIST:
                $this->result = $this->parseUriList($result_string);
                break;
        }
    }

References $result_type, parseUriList(), RESULT_TYPE_JSON, and RESULT_TYPE_URL_LIST.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

parseUriList()

ilECSResult::parseUriList ( string  $a_content )

private

Parameters

string

$a_content

Returns

ilECSUriList

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

                                                    : \ilECSUriList
    {
        $list = new ilECSUriList();
        $lines = explode("\n", $a_content);
        foreach ($lines as $line) {
            $line = trim($line);
            if ($line === '') {
                continue;
            }
            $uri_parts = explode("/", $line);
            $list->add($line, (int) array_pop($uri_parts));
        }
 
        return $list;
    }

Referenced by init().

Here is the caller graph for this function:

setHeaders()

ilECSResult::setHeaders

(

array

$a_headers

)

Set header.

Parameters

array

$a_headers

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

                                                : void
    {
        $this->headers = $a_headers;
    }

setHTTPCode()

ilECSResult::setHTTPCode

(

int

$a_code

)

set HTTP return code

@access public

Parameters

string

http code

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

                                            : void
    {
        $this->http_code = $a_code;
    }

Field Documentation

$headers

array ilECSResult::$headers = array()

private

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

$http_code

int ilECSResult::$http_code = 0

private

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

Referenced by getHTTPCode().

$result

ilECSResult::$result

private

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

Referenced by getResult().

$result_type

int ilECSResult::$result_type

private

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

Referenced by getResultType(), and init().

RESULT_TYPE_JSON

const ilECSResult::RESULT_TYPE_JSON = 1

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

Referenced by init().

RESULT_TYPE_URL_LIST

const ilECSResult::RESULT_TYPE_URL_LIST = 2

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

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

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSResult.php