ilSoapStructureObject Class Reference

Inheritance diagram for ilSoapStructureObject:

Collaboration diagram for ilSoapStructureObject:

Public Member Functions
	__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...

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

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

Reimplemented in ilSoapRepositoryStructureObject.

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

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

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

Here is the call graph for this function:

Member Function Documentation

_getTagName()

ilSoapStructureObject::_getTagName

(

)

Reimplemented in ilSoapRepositoryStructureObject.

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

    {
        return "StructureObject";
    }

Referenced by exportXML().

Here is the caller graph for this function:

_getXMLAttributes()

ilSoapStructureObject::_getXMLAttributes

(

)

get xml tag attributes

Reimplemented in ilSoapRepositoryStructureObject.

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

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

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 58 of file class.ilSoapStructureObject.php.

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

exportXML()

ilSoapStructureObject::exportXML

(

$xml_writer

)

export to xml writer

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

    {
        $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());
    }

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 126 of file class.ilSoapStructureObject.php.

    {
        return $this->description;
    }

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 156 of file class.ilSoapStructureObject.php.

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

References CLIENT_ID, getObjId(), getParentRefId(), and getType().

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 165 of file class.ilSoapStructureObject.php.

    {
        die("abstract");
    }

Referenced by exportXML().

Here is the caller graph for this function:

getObjId()

ilSoapStructureObject::getObjId

(

)

return current object id

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

    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by ilSoapRepositoryStructureObject\_getXMLAttributes(), _getXMLAttributes(), getGotoLink(), ilSoapGLOTermStructureObject\getInternalLink(), ilSoapLMChapterStructureObject\getInternalLink(), and ilSoapLMPageStructureObject\getInternalLink().

Here is the caller graph for this function:

getParentRefId()

ilSoapStructureObject::getParentRefId

(

)

read access to parents ref id

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

    {
        return $this->parentRefId;
    }

References $parentRefId.

Referenced by getGotoLink().

Here is the caller graph for this function:

getStructureObjects()

ilSoapStructureObject::getStructureObjects

(

)

returns sub structure elements

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

    {
        return $this->structureObjects;
    }

References $structureObjects.

Referenced by exportXML().

Here is the caller graph for this function:

getTitle()

ilSoapStructureObject::getTitle

(

)

return current title

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

    {
        return $this->title;
    }

References $title.

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

Here is the caller graph for this function:

getType()

ilSoapStructureObject::getType

(

)

return current type

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

    {
        return $this->type;
    }

References $type.

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

Here is the caller graph for this function:

setDescription()

ilSoapStructureObject::setDescription

(

$value

)

set current description

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

    {
        $this->description = $value;
    }

Referenced by __construct().

Here is the caller graph for this function:

setObjId()

ilSoapStructureObject::setObjId

(

$value

)

set current ObjId

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

    {
        $this->obj_id= $value;
    }

Referenced by __construct().

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 189 of file class.ilSoapStructureObject.php.

    {
        $this->parentRefId = $parentRefId;
    }

References $parentRefId.

setTitle()

ilSoapStructureObject::setTitle

(

$value

)

set current title

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

    {
        $this->title= $value;
    }

Referenced by __construct().

Here is the caller graph for this function:

setType()

ilSoapStructureObject::setType

(

$value

)

set current type

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

    {
        $this->type = $value;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$description

ilSoapStructureObject::$description

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

Referenced by __construct(), ilSoapRepositoryStructureObject\__construct(), and getDescription().

$obj_id

ilSoapStructureObject::$obj_id

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

Referenced by getObjId().

$parentRefId

ilSoapStructureObject::$parentRefId

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

Referenced by __construct(), getParentRefId(), and setParentRefId().

$structureObjects

ilSoapStructureObject::$structureObjects = array()

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

Referenced by exportXML(), and getStructureObjects().

$title

ilSoapStructureObject::$title

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

Referenced by __construct(), ilSoapRepositoryStructureObject\__construct(), and getTitle().

$type

ilSoapStructureObject::$type

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

Referenced by __construct(), ilSoapRepositoryStructureObject\__construct(), and getType().

---

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

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