ilECSDirectoryTreeConnector Class Reference

Inheritance diagram for ilECSDirectoryTreeConnector:

Collaboration diagram for ilECSDirectoryTreeConnector:

Public Member Functions
	getDirectoryTrees (int $a_mid=0)
	Get directory tree. More...
	getDirectoryTree ($tree_id)
	Get single directory tree. More...
Public Member Functions inherited from ilECSConnector
	__construct (?ilECSSetting $settings=null)
	addHeader (string $a_name, string $a_value)
	Add Header. More...
	getHeader ()
	setHeader (array $a_header_strings)
	getServer ()
	Get current server setting. More...
	addAuth (string $a_post, int $a_target_mid)
	Add auth resource. More...
	getAuth (string $a_hash, bool $a_details_only=false)
	get auth resource More...
	readEventFifo (bool $a_delete=false)
	Read event fifo. More...
	getResourceList (string $a_path)
	getResource (string $a_path, int $a_econtent_id, bool $a_details_only=false)
	Get resources from ECS server. More...
	addResource (string $a_path, $a_post)
	Add resource. More...
	updateResource (string $a_path, int $a_econtent_id, string $a_post_string)
	update resource More...
	deleteResource (string $a_path, int $a_econtent_id)
	Delete resource. More...
	getMemberships (int $a_mid=0)

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...
Protected Attributes inherited from ilECSConnector
string	$path_postfix = ''
ilECSSetting	$settings = null
ilCurlConnection	$curl = null
array	$header_strings = []
ilLogger	$logger

Detailed Description

Author

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

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

Member Function Documentation

getDirectoryTree()

ilECSDirectoryTreeConnector::getDirectoryTree

(

$tree_id

)

Get single directory tree.

Returns

ilECSResult an array of ecs cms directory tree entries

Definition at line 59 of file class.ilECSDirectoryTreeConnector.php.

References Vendor\Package\$e, $res, ilECSConnector\addHeader(), ilECSConnector\call(), ilECSConnector\getHeader(), ILIAS\Repository\int(), ilECSConnector\prepareConnection(), and ilECSConnector\setHeader().

                                              : ilECSResult
    {
        $this->path_postfix = '/campusconnect/directory_trees/' . (int) $tree_id;

        try {
            $this->prepareConnection();
            $this->setHeader(array());
            $this->addHeader('Accept', 'text/uri-list');
            $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
            $res = $this->call();

            if (strpos($res, 'http') === 0) {
                $json = file_get_contents($res);
                $ecs_result = new ilECSResult($json);
            } else {
                $ecs_result = new ilECSResult($res);
            }
            return $ecs_result;
        } catch (ilCurlConnectionException $e) {
            throw new ilECSConnectorException('Error calling ECS service: ' . $e->getMessage());
        }
    }

Here is the call graph for this function:

getDirectoryTrees()

ilECSDirectoryTreeConnector::getDirectoryTrees

(

int

$a_mid = 0

)

Get directory tree.

Exceptions

ilECSConnectorException

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

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

                                                     : ?\ilECSUriList
    {
        $this->path_postfix = '/campusconnect/directory_trees';

        try {
            $this->prepareConnection();
            $this->setHeader(array());
            $this->addHeader('Accept', 'text/uri-list');
            $this->addHeader('X-EcsQueryStrings', 'all=true');
            if ($a_mid) {
                $this->addHeader('X-EcsReceiverMemberships', (string) $a_mid);
            }

            $this->curl->setOpt(CURLOPT_HTTPHEADER, $this->getHeader());
            $res = $this->call();

            return (new ilECSResult($res, ilECSResult::RESULT_TYPE_URL_LIST))->getResult();
        } catch (ilCurlConnectionException $exc) {
            throw new ilECSConnectorException('Error calling ECS service: ' . $exc->getMessage());
        }
    }

Here is the call graph for this function:

---

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

• components/ILIAS/WebServices/ECS/classes/Tree/class.ilECSDirectoryTreeConnector.php