ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilSoapStructureObject Class Reference
+ Inheritance diagram for ilSoapStructureObject:
+ Collaboration diagram for ilSoapStructureObject:

Public Member Functions

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

Data Fields

 $obj_id
 
 $title
 
 $type
 
 $description
 
 $parentRefId
 
 $structureObjects = array ()
 

Detailed Description

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

Member Function Documentation

◆ _getTagName()

ilSoapStructureObject::_getTagName ( )

Reimplemented in ilSoapRepositoryStructureObject.

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

175 {
176 return "StructureObject";
177 }

Referenced by exportXML().

+ Here is the caller graph for this function:

◆ _getXMLAttributes()

ilSoapStructureObject::_getXMLAttributes ( )

get xml tag attributes

Reimplemented in ilSoapRepositoryStructureObject.

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

168 {
169 return array( 'type' => $this->getType(),
170 'obj_id' => $this->getObjId()
171 );
172 }
getObjId()
return current object id

References getObjId(), and getType().

Referenced by exportXML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addStructureObject()

ilSoapStructureObject::addStructureObject (   $structureObject)

add structure object to its parent

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

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

◆ exportXML()

ilSoapStructureObject::exportXML (   $xml_writer)

export to xml writer

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

200 {
201 $attrs = $this->_getXMLAttributes();
202
203 // open tag
204 $xml_writer->xmlStartTag($this->_getTagName(), $attrs);
205
206 $xml_writer->xmlElement('Title',null,$this->getTitle());
207 $xml_writer->xmlElement('Description',null,$this->getDescription());
208 $xml_writer->xmlElement('InternalLink',null,$this->getInternalLink());
209 $xml_writer->xmlElement('GotoLink',null,$this->getGotoLink());
210
211 $xml_writer->xmlStartTag("StructureObjects");
212
213 // handle sub elements
215
216 foreach ($structureObjects as $structureObject)
217 {
218 $structureObject->exportXML ($xml_writer);
219 }
220
221 $xml_writer->xmlEndTag("StructureObjects");
222
223 $xml_writer->xmlEndTag($this->_getTagName());
224
225 }
getInternalLink()
return current internal_link
getGotoLink()
return current goto_link
_getXMLAttributes()
get xml tag attributes
getStructureObjects()
returns sub structure elements
getDescription()
return current description

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

+ Here is the call graph for this function:

◆ getDescription()

ilSoapStructureObject::getDescription ( )

return current description

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

References $description.

Referenced by exportXML().

+ Here is the caller graph for this function:

◆ getGotoLink()

ilSoapStructureObject::getGotoLink ( )

return current goto_link

Reimplemented in ilSoapGLOTermDefinitionStructureObject, ilSoapLMChapterStructureObject, and ilSoapRepositoryStructureObject.

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

150 {
151 return ILIAS_HTTP_PATH."/". "goto.php?target=".$this->getType()."_".$this->getObjId().(is_numeric ($this->getParentRefId())?"_".$this->getParentRefId():"")."&client_id=".CLIENT_ID;
152 }
getParentRefId()
read access to parents ref id

References getObjId(), and getParentRefId().

Referenced by exportXML().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getInternalLink()

ilSoapStructureObject::getInternalLink ( )

return current internal_link

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

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

159 {
160 die ("abstract");
161 }

Referenced by exportXML().

+ Here is the caller graph for this function:

◆ getObjId()

ilSoapStructureObject::getObjId ( )

return current object id

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

References $obj_id.

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

+ Here is the caller graph for this function:

◆ getParentRefId()

ilSoapStructureObject::getParentRefId ( )

read access to parents ref id

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

References $parentRefId.

Referenced by getGotoLink().

+ Here is the caller graph for this function:

◆ getStructureObjects()

ilSoapStructureObject::getStructureObjects ( )

returns sub structure elements

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

66 {
68 }

References $structureObjects.

Referenced by exportXML().

+ Here is the caller graph for this function:

◆ getTitle()

ilSoapStructureObject::getTitle ( )

◆ getType()

ilSoapStructureObject::getType ( )

return current type

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

References $type.

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

+ Here is the caller graph for this function:

◆ ilSoapStructureObject()

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

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

45 {
46 $this->setObjId ($objId);
47 $this->setType ($type);
48 $this->setTitle ($title);
50 $this->parentRefId = $parentRefId;
51 }
setObjId($value)
set current ObjId
setTitle($value)
set current title
setType($value)
set current type
setDescription($value)
set current description

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

+ Here is the call graph for this function:

◆ setDescription()

ilSoapStructureObject::setDescription (   $value)

set current description

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

111 {
112 $this->description = $value;
113 }

Referenced by ilSoapStructureObject().

+ Here is the caller graph for this function:

◆ setObjId()

ilSoapStructureObject::setObjId (   $value)

set current ObjId

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

75 {
76 $this->obj_id= $value;
77 }

Referenced by ilSoapStructureObject().

+ Here is the caller graph for this function:

◆ setParentRefId()

ilSoapStructureObject::setParentRefId (   $parentRefId)

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

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

183 {
184 $this->parentRefId = $parentRefId;
185 }

References $parentRefId.

◆ setTitle()

ilSoapStructureObject::setTitle (   $value)

set current title

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

94 {
95 $this->title= $value;
96 }

Referenced by ilSoapStructureObject().

+ Here is the caller graph for this function:

◆ setType()

ilSoapStructureObject::setType (   $value)

set current type

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

130 {
131 $this->type = $value;
132 }

Referenced by ilSoapStructureObject().

+ Here is the caller graph for this function:

Field Documentation

◆ $description

◆ $obj_id

ilSoapStructureObject::$obj_id

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

Referenced by getObjId().

◆ $parentRefId

◆ $structureObjects

ilSoapStructureObject::$structureObjects = array ()

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

Referenced by exportXML(), and getStructureObjects().

◆ $title

◆ $type


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