ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree Class Reference

Class OrgUnitTree. More...

Inheritance diagram for ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree:

Collaboration diagram for ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree:

Public Member Functions
	getName ()
	Get the name of the method. More...
	getOutputParams ()
	Get the output parameters in the same format as the input parameters. More...
	getDocumentation ()
	Get the documentation of this method. More...
Public Member Functions inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
	__construct ()
	getServiceStyle ()
	Get the service style, e.g. More...
	getServiceUse ()
	Get the service use, e.g. More...
	getServiceNamespace ()
	Get the namespace of the service where this method belongs to. More...
	getInputParams ()
	Get the input parameters. More...
	execute (array $params)
	Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name). More...
	addError (string $message)
Public Member Functions inherited from ilSoapAdministration
	__construct (bool $use_nusoap=true)
	getMessage ()
	appendMessage (string $a_str)
	setMessageCode (string $a_code)
	getMessageCode ()
	reInitUser ()
	isFault ($object)
	getInstallationInfoXML ()
	getClientInfoXML (string $clientid)

Data Fields
const	ORGU_REF_ID = 'orgu_ref_id'
const	ORG_UNIT_TREE = 'OrgUnitTree'
Data Fields inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
const	TYPE_INT_ARRAY = 'tns:intArray'
const	TYPE_STRING = 'xsd:string'
const	TYPE_INT = 'xsd:int'
const	TYPE_DOUBLE_ARRAY = 'tns:doubleArray'
const	SID = 'sid'
const	ORGU_REF_ID = 'orgu_ref_id'
const	POSITION_ID = 'position_id'
const	USR_IDS = 'usr_ids'
const	USR_ID = 'usr_id'
Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1
const	PHP5 = 2
int	$error_method
	Defines type of error handling (PHP5 || NUSOAP) More...

Protected Member Functions
	run (array $params)
	getAdditionalInputParams ()
Protected Member Functions inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
	initIliasAndCheckSession (string $session_id)
	Use this method at the beginning of your execute() method to check if the provided session ID is valid. More...
	checkParameters (array $params)
	Check that all input parameters are present when executing the soap method. More...
	getAdditionalInputParams ()
	run (array $params)
Protected Member Functions inherited from ilSoapAdministration
	checkSession (string $sid)
	explodeSid (string $sid)
	setMessage (string $a_str)
	initAuth (string $sid)
	initIlias ()
	initAuthenticationObject ()
	raiseError (string $a_message, $a_code)
	checkObjectAccess (int $ref_id, array $expected_type, string $permission, bool $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...

Additional Inherited Members
Protected Attributes inherited from ILIAS\OrgUnit\Webservices\SOAP\Base
ilOrgUnitPositionDBRepository	$positionRepo
ilOrgUnitUserAssignmentDBRepository	$assignmentRepo
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

Class OrgUnitTree.

Author

Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 27 of file OrgUnitTree.php.

Member Function Documentation

getAdditionalInputParams()

ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::getAdditionalInputParams ( )

protected

Definition at line 46 of file OrgUnitTree.php.

References ILIAS\OrgUnit\Webservices\SOAP\Base\TYPE_INT.

                                                 : array
    {
        return array(
            self::ORGU_REF_ID => Base::TYPE_INT,
        );
    }

getDocumentation()

ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::getDocumentation

(

)

Get the documentation of this method.

Returns

string

Implements ilSoapMethod.

Definition at line 58 of file OrgUnitTree.php.

                                      : string
    {
        return "Returns the ILIAS Organisational Units (SimpleXML)";
    }

getName()

ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::getName

(

)

Get the name of the method.

Used as endpoint for SOAP requests. Note that this name must be unique in combination with the service namespace.

Returns

string

Implements ilSoapMethod.

Definition at line 41 of file OrgUnitTree.php.

                             : string
    {
        return "getOrgUnitsSimpleXML";
    }

getOutputParams()

ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::getOutputParams

(

)

Get the output parameters in the same format as the input parameters.

Returns

array

Implements ilSoapMethod.

Definition at line 53 of file OrgUnitTree.php.

References ILIAS\OrgUnit\Webservices\SOAP\Base\TYPE_STRING.

                                     : array
    {
        return array(self::ORG_UNIT_TREE => Base::TYPE_STRING);
    }

run()

ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::run ( array  $params )

protected

Definition at line 32 of file OrgUnitTree.php.

                                         : string
    {
        $orgu_ref_id = $params[self::ORGU_REF_ID];

        $orgu_exporter = new ilOrgUnitExporter();

        return $orgu_exporter->simpleExport($orgu_ref_id)->xmlDumpMem(true);
    }

Field Documentation

ORG_UNIT_TREE

const ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::ORG_UNIT_TREE = 'OrgUnitTree'

Definition at line 30 of file OrgUnitTree.php.

ORGU_REF_ID

const ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree::ORGU_REF_ID = 'orgu_ref_id'

Definition at line 29 of file OrgUnitTree.php.

---

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

• components/ILIAS/OrgUnit/classes/Webservices/SOAP/OrgUnitTree.php