ilSOAPStructureObjectAdministration Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSOAPStructureObjectAdministration:

Collaboration diagram for ilSOAPStructureObjectAdministration:

Public Member Functions
	getStructureObjects (string $sid, int $ref_id)
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)

Additional Inherited Members
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 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...
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning administration for structure objects

Author

Roland Kuestermann (rku@a.nosp@m.ifb..nosp@m.uni-k.nosp@m.arls.nosp@m.ruhe..nosp@m.de)

Definition at line 22 of file class.ilSoapStructureObjectAdministration.php.

Member Function Documentation

getStructureObjects()

ilSOAPStructureObjectAdministration::getStructureObjects	(	string	$sid,
		int	$ref_id
	)

Returns

soap_fault|SoapFault|string|null

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

References $filename, ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }

        if (!$target_obj = ilObjectFactory::getInstanceByRefId($ref_id, false)) {
            return $this->raiseError('No valid reference id given.', 'Client');
        }

        $structureReaderClassname = "ilSoap" . strtoupper($target_obj->getType()) . "StructureReader";
        $filename = "./components/ILIAS/soap/classes/class." . $structureReaderClassname . ".php";

        if (!file_exists($filename)) {
            return $this->raiseError("Object type '" . $target_obj->getType() . "'is not supported.", 'Client');
        }

        include_once $filename;
        $structureReader = new $structureReaderClassname($target_obj);
        $xml_writer = new ilSoapStructureObjectXMLWriter();
        $structureObject = &$structureReader->getStructureObject();
        $xml_writer->setStructureObject($structureObject);
        if (!$xml_writer->start()) {
            return $this->raiseError('Cannot create object xml !', 'Server');
        }
        return $xml_writer->getXML();
    }

Here is the call graph for this function:

---

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

• components/ILIAS/soap/classes/class.ilSoapStructureObjectAdministration.php