Inheritance diagram for ilSoapStructureObject:

Public Member Functions
	ilSoapStructureObject ($objId, $type, $title, $description, $parentRefId=null)
	addStructureObject ($structureObject)
	add structure object to its parent
	getStructureObjects ()
	returns sub structure elements
	setObjId ($value)
	set current ObjId
	getObjId ()
	return current object id
	setTitle ($value)
	set current title
	getTitle ()
	return current title
	setDescription ($value)
	set current description
	getDescription ()
	return current description
	setType ($value)
	set current type
	getType ()
	return current type
	getGotoLink ()
	return current goto_link
	getInternalLink ()
	return current internal_link
	_getXMLAttributes ()
	get xml tag attributes
	_getTagName ()
	setParentRefId ($parentRefId)
	set ref id for parent object (used for permanent link if set)
	getParentRefId ()
	read access to parents ref id
	exportXML ($xml_writer)
	export to xml writer
Data Fields
	$obj_id
	$title
	$type
	$description
	$parentRefId
	$structureObjects = array ()

Detailed Description

Definition at line 34 of file class.ilSoapStructureObject.php.

Member Function Documentation

ilSoapStructureObject::_getTagName ( )

Reimplemented in ilSoapRepositoryStructureObject.

Definition at line 174 of file class.ilSoapStructureObject.php.

Referenced by exportXML().

        {
                return "StructureObject";
        }

Here is the caller graph for this function:

ilSoapStructureObject::_getXMLAttributes ( )

get xml tag attributes

Reimplemented in ilSoapRepositoryStructureObject.

Definition at line 167 of file class.ilSoapStructureObject.php.

References getObjId(), and getType().

Referenced by exportXML().

        {
                return array(   'type' => $this->getType(),
                                                'obj_id' => $this->getObjId()
                );
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapStructureObject::addStructureObject ( $ structureObject )

add structure object to its parent

Definition at line 57 of file class.ilSoapStructureObject.php.

        {
                $this->structureObjects [$structureObject->getObjId()] =  $structureObject;
        }

ilSoapStructureObject::exportXML ( $ xml_writer )

export to xml writer

Definition at line 200 of file class.ilSoapStructureObject.php.

References $structureObjects, _getTagName(), _getXMLAttributes(), getDescription(), getGotoLink(), getInternalLink(), getStructureObjects(), and getTitle().

                                          {
                $attrs = $this->_getXMLAttributes();

                // open tag
                $xml_writer->xmlStartTag($this->_getTagName(), $attrs);

                $xml_writer->xmlElement('Title',null,$this->getTitle());
                $xml_writer->xmlElement('Description',null,$this->getDescription());
                $xml_writer->xmlElement('InternalLink',null,$this->getInternalLink());
                $xml_writer->xmlElement('GotoLink',null,$this->getGotoLink());

                $xml_writer->xmlStartTag("StructureObjects");

                // handle sub elements
                $structureObjects = $this->getStructureObjects();

                foreach ($structureObjects as $structureObject)
                {
                        $structureObject->exportXML ($xml_writer);
                }

                $xml_writer->xmlEndTag("StructureObjects");

                $xml_writer->xmlEndTag($this->_getTagName());

         }

Here is the call graph for this function:

ilSoapStructureObject::getDescription ( )

return current description

Definition at line 120 of file class.ilSoapStructureObject.php.

Referenced by exportXML().

                                   {
                return $this->description;
        }

Here is the caller graph for this function:

ilSoapStructureObject::getGotoLink ( )

return current goto_link

Reimplemented in ilSoapGLOTermDefinitionStructureObject, ilSoapLMChapterStructureObject, and ilSoapRepositoryStructureObject.

Definition at line 149 of file class.ilSoapStructureObject.php.

References getObjId(), and getParentRefId().

Referenced by exportXML().

        {
                return ILIAS_HTTP_PATH."/". "goto.php?target=".$this->getType()."_".$this->getObjId().(is_numeric ($this->getParentRefId())?"_".$this->getParentRefId():"")."&client_id=".CLIENT_ID;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapStructureObject::getInternalLink ( )

return current internal_link

Reimplemented in ilSoapGLOTermDefinitionStructureObject, ilSoapGLOTermStructureObject, ilSoapLMChapterStructureObject, ilSoapLMPageStructureObject, and ilSoapRepositoryStructureObject.

Definition at line 158 of file class.ilSoapStructureObject.php.

Referenced by exportXML().

        {
                die ("abstract");
        }

Here is the caller graph for this function:

ilSoapStructureObject::getObjId ( )

return current object id

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

Referenced by _getXMLAttributes(), ilSoapRepositoryStructureObject::_getXMLAttributes(), and getGotoLink().

        {
                return $this->obj_id;
        }

Here is the caller graph for this function:

ilSoapStructureObject::getParentRefId ( )

read access to parents ref id

Definition at line 191 of file class.ilSoapStructureObject.php.

Referenced by getGotoLink().

        {
                return $this->parentRefId;
        }

Here is the caller graph for this function:

ilSoapStructureObject::getStructureObjects ( )

returns sub structure elements

Definition at line 66 of file class.ilSoapStructureObject.php.

Referenced by exportXML().

                                         {
                return $this->structureObjects;
        }

Here is the caller graph for this function:

ilSoapStructureObject::getTitle ( )

return current title

Definition at line 103 of file class.ilSoapStructureObject.php.

Referenced by exportXML(), ilSoapRepositoryStructureObject::getInternalLink(), ilSoapLMPageStructureObject::getInternalLink(), ilSoapLMChapterStructureObject::getInternalLink(), and ilSoapGLOTermStructureObject::getInternalLink().

                             {
                return $this->title;
        }

Here is the caller graph for this function:

ilSoapStructureObject::getType ( )

return current type

Definition at line 139 of file class.ilSoapStructureObject.php.

Referenced by _getXMLAttributes(), and ilSoapRepositoryStructureObject::_getXMLAttributes().

        {
                return $this->type;
        }

Here is the caller graph for this function:

ilSoapStructureObject::ilSoapStructureObject	(	$	objId,
		$	type,
		$	title,
		$	description,
		$	parentRefId = `null`
	)

Definition at line 45 of file class.ilSoapStructureObject.php.

References $description, $parentRefId, $title, $type, setDescription(), setObjId(), setTitle(), and setType().

Referenced by ilSoapGLOTermDefinitionStructureObject::ilSoapGLOTermDefinitionStructureObject(), ilSoapGLOTermStructureObject::ilSoapGLOTermStructureObject(), ilSoapLMChapterStructureObject::ilSoapLMChapterStructureObject(), ilSoapLMPageStructureObject::ilSoapLMPageStructureObject(), and ilSoapRepositoryStructureObject::ilSoapRepositoryStructureObject().

                                                                                                  {
                $this->setObjId ($objId);
                $this->setType ($type);
                $this->setTitle ($title);
                $this->setDescription ($description);
                $this->parentRefId = $parentRefId;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapStructureObject::setDescription ( $ value )

set current description

Definition at line 111 of file class.ilSoapStructureObject.php.

Referenced by ilSoapStructureObject().

                                         {
                $this->description = $value;
        }

Here is the caller graph for this function:

ilSoapStructureObject::setObjId ( $ value )

set current ObjId

Definition at line 75 of file class.ilSoapStructureObject.php.

Referenced by ilSoapStructureObject().

                                   {
                $this->obj_id= $value;
        }

Here is the caller graph for this function:

ilSoapStructureObject::setParentRefId ( $ parentRefId )

set ref id for parent object (used for permanent link if set)

Definition at line 182 of file class.ilSoapStructureObject.php.

References $parentRefId.

        {
                $this->parentRefId = $parentRefId;
        }

ilSoapStructureObject::setTitle ( $ value )

set current title

Definition at line 94 of file class.ilSoapStructureObject.php.

Referenced by ilSoapStructureObject().

                                   {
                $this->title= $value;
        }

Here is the caller graph for this function:

ilSoapStructureObject::setType ( $ value )

set current type

Definition at line 129 of file class.ilSoapStructureObject.php.

Referenced by ilSoapStructureObject().

        {
                $this->type = $value;
        }

Here is the caller graph for this function:

Field Documentation

ilSoapStructureObject::$description

Definition at line 39 of file class.ilSoapStructureObject.php.

Referenced by ilSoapGLOTermDefinitionStructureObject::ilSoapGLOTermDefinitionStructureObject(), ilSoapGLOTermStructureObject::ilSoapGLOTermStructureObject(), ilSoapLMChapterStructureObject::ilSoapLMChapterStructureObject(), ilSoapLMPageStructureObject::ilSoapLMPageStructureObject(), ilSoapRepositoryStructureObject::ilSoapRepositoryStructureObject(), and ilSoapStructureObject().

ilSoapStructureObject::$obj_id

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

ilSoapStructureObject::$parentRefId

Definition at line 40 of file class.ilSoapStructureObject.php.

Referenced by ilSoapGLOTermDefinitionStructureObject::ilSoapGLOTermDefinitionStructureObject(), ilSoapGLOTermStructureObject::ilSoapGLOTermStructureObject(), ilSoapLMChapterStructureObject::ilSoapLMChapterStructureObject(), ilSoapLMPageStructureObject::ilSoapLMPageStructureObject(), ilSoapStructureObject(), and setParentRefId().

ilSoapStructureObject::$structureObjects = array ()

Definition at line 42 of file class.ilSoapStructureObject.php.

Referenced by exportXML().

ilSoapStructureObject::$title

Definition at line 37 of file class.ilSoapStructureObject.php.

Referenced by ilSoapGLOTermDefinitionStructureObject::ilSoapGLOTermDefinitionStructureObject(), ilSoapGLOTermStructureObject::ilSoapGLOTermStructureObject(), ilSoapLMChapterStructureObject::ilSoapLMChapterStructureObject(), ilSoapLMPageStructureObject::ilSoapLMPageStructureObject(), ilSoapRepositoryStructureObject::ilSoapRepositoryStructureObject(), and ilSoapStructureObject().

ilSoapStructureObject::$type

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

Referenced by ilSoapGLOTermDefinitionStructureObject::ilSoapGLOTermDefinitionStructureObject(), ilSoapGLOTermStructureObject::ilSoapGLOTermStructureObject(), ilSoapLMChapterStructureObject::ilSoapLMChapterStructureObject(), ilSoapLMPageStructureObject::ilSoapLMPageStructureObject(), ilSoapRepositoryStructureObject::ilSoapRepositoryStructureObject(), and ilSoapStructureObject().

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

webservice/soap/classes/class.ilSoapStructureObject.php

ilSoapStructureObject Class Reference

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation