ilSOAPStructureObjectAdministration Class Reference

Inheritance diagram for ilSOAPStructureObjectAdministration:

Collaboration diagram for ilSOAPStructureObjectAdministration:

Public Member Functions
	ilSOAPStructureObjectAdministration ()
	getStructureObjects ($sid, $ref_id)
Public Member Functions inherited from ilSoapAdministration
	ilSoapAdministration ($use_nusoap=true)
	initErrorWriter ()
	Overwrite error handler. More...
	__explodeSid ($sid)
	__setMessage ($a_str)
	__getMessage ()
	__appendMessage ($a_str)
	__setMessageCode ($a_code)
	__getMessageCode ()
	initAuth ($sid)
	initIlias ()
	__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
	__raiseError ($a_message, $a_code)
	getNIC ($sid)
	get client information from current as xml result set More...
	isFault ($object)
	checkObjectAccess ($ref_id, $expected_type, $permission, $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
	getInstallationInfoXML ()
	getClientInfoXML ($clientid)

Additional Inherited Members
Static Public Member Functions inherited from ilSoapAdministration
static	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes More...
Data Fields inherited from ilSoapAdministration
	$sauth = null
	$error_method = null
Protected Attributes inherited from ilSoapAdministration
	$soap_check = true

Detailed Description

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

Member Function Documentation

getStructureObjects()

ilSOAPStructureObjectAdministration::getStructureObjects	(		$sid,
			$ref_id
	)

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

        {
                $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 = "./webservice/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);
 
                include_once './webservice/soap/classes/class.ilSoapStructureObjectXMLWriter.php';
 
                $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();
 
        }

References $filename, $ref_id, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

ilSOAPStructureObjectAdministration()

ilSOAPStructureObjectAdministration::ilSOAPStructureObjectAdministration

(

)

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

        {
                parent::ilSoapAdministration();
        }

---

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

• webservice/soap/classes/class.ilSoapStructureObjectAdministration.php