ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilSoapRepositoryStructureObject Class Reference
+ Inheritance diagram for ilSoapRepositoryStructureObject:
+ Collaboration diagram for ilSoapRepositoryStructureObject:

Public Member Functions

 __construct ($objId, $type, $title, $description, $refId)
 Constructor. More...
 
 setRefId ($value)
 set current refId More...
 
 getRefId ()
 return current ref id More...
 
 getInternalLink ()
 return current internal_link More...
 
 getGotoLink ()
 return current goto_link More...
 
 _getXMLAttributes ()
 get xml tag attributes More...
 
 _getTagName ()
 
- Public Member Functions inherited from ilSoapStructureObject
 __construct ($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...
 

Protected Attributes

 $ref_id
 

Additional Inherited Members

- Data Fields inherited from ilSoapStructureObject
 $obj_id
 
 $title
 
 $type
 
 $description
 
 $parentRefId
 
 $structureObjects = array ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSoapRepositoryStructureObject::__construct (   $objId,
  $type,
  $title,
  $description,
  $refId 
)

Constructor.

Parameters
type$objId
type$type
type$title
type$description
type$refId

Reimplemented from ilSoapStructureObject.

Definition at line 50 of file class.ilSoapRepositoryStructureObject.php.

References ilSoapStructureObject\$description, ilSoapStructureObject\$title, ilSoapStructureObject\$type, and setRefId().

+ Here is the call graph for this function:

Member Function Documentation

◆ _getTagName()

ilSoapRepositoryStructureObject::_getTagName ( )

Reimplemented from ilSoapStructureObject.

Definition at line 91 of file class.ilSoapRepositoryStructureObject.php.

91 {
92 return "RepositoryObject";
93 }

◆ _getXMLAttributes()

ilSoapRepositoryStructureObject::_getXMLAttributes ( )

get xml tag attributes

Reimplemented from ilSoapStructureObject.

Definition at line 82 of file class.ilSoapRepositoryStructureObject.php.

82 {
83 $attrs = array( 'type' => $this->getType(),
84 'obj_id' => $this->getObjId(),
85 'ref_id' => $this->getRefId());
86
87 return $attrs;
88
89 }
getObjId()
return current object id

References ilSoapStructureObject\getObjId(), getRefId(), and ilSoapStructureObject\getType().

+ Here is the call graph for this function:

◆ getGotoLink()

ilSoapRepositoryStructureObject::getGotoLink ( )

return current goto_link

Reimplemented from ilSoapStructureObject.

Definition at line 78 of file class.ilSoapRepositoryStructureObject.php.

78 {
79 return ILIAS_HTTP_PATH."/". "goto.php?target=".$this->getType()."_".$this->getRefId()."&client_id=".CLIENT_ID;
80 }

References getRefId().

+ Here is the call graph for this function:

◆ getInternalLink()

ilSoapRepositoryStructureObject::getInternalLink ( )

return current internal_link

Reimplemented from ilSoapStructureObject.

Definition at line 74 of file class.ilSoapRepositoryStructureObject.php.

74 {
75 return "[iln ".$this->getType()."=\"".$this->getRefId()."\"]".$this->getTitle()."[/iln]";
76 }

References getRefId(), and ilSoapStructureObject\getTitle().

+ Here is the call graph for this function:

◆ getRefId()

ilSoapRepositoryStructureObject::getRefId ( )

return current ref id

Definition at line 69 of file class.ilSoapRepositoryStructureObject.php.

References $ref_id.

Referenced by _getXMLAttributes(), getGotoLink(), and getInternalLink().

+ Here is the caller graph for this function:

◆ setRefId()

ilSoapRepositoryStructureObject::setRefId (   $value)

set current refId

Definition at line 60 of file class.ilSoapRepositoryStructureObject.php.

60 {
61 $this->ref_id= $value;
62 }

Referenced by __construct().

+ Here is the caller graph for this function:

Field Documentation

◆ $ref_id

ilSoapRepositoryStructureObject::$ref_id
protected

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

Referenced by getRefId().


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