ilSoapStructureObject Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSoapStructureObject:

Collaboration diagram for ilSoapStructureObject:

Public Member Functions
	__construct (int $objId, string $type, string $title, string $description, ?int $parentRefId=null)
	addStructureObject (ilSoapStructureObject $structureObject)
	getStructureObjects ()
	setObjId (int $value)
	getObjId ()
	setTitle (string $value)
	getTitle ()
	setDescription (string $value)
	getDescription ()
	setType (string $value)
	getType ()
	getGotoLink ()
	getInternalLink ()
	_getXMLAttributes ()
	_getTagName ()
	setParentRefId (int $parentRefId)
	getParentRefId ()
	exportXML (ilXmlWriter $xml_writer)

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Abstract classs for soap structure objects

Author

Roland Kuestermann (rku@a.nosp@m.ifb..nosp@m.uni-k.nosp@m.arls.nosp@m.ruhe..nosp@m.de)

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

Constructor & Destructor Documentation

__construct()

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

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

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

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

Here is the call graph for this function:

Member Function Documentation

_getTagName()

ilSoapStructureObject::_getTagName

(

)

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

Referenced by exportXML().

                                 : string
    {
        return "StructureObject";
    }

Here is the caller graph for this function:

_getXMLAttributes()

ilSoapStructureObject::_getXMLAttributes

(

)

Returns

array{type: string, obj_id: int}

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

References getObjId(), and getType().

Referenced by exportXML().

                                       : array
    {
        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:

addStructureObject()

ilSoapStructureObject::addStructureObject

(

ilSoapStructureObject

$structureObject

)

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

References getObjId().

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

Here is the call graph for this function:

exportXML()

ilSoapStructureObject::exportXML

(

ilXmlWriter

$xml_writer

)

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

References _getTagName(), _getXMLAttributes(), getDescription(), getGotoLink(), getInternalLink(), getStructureObjects(), getTitle(), null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

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

        $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");

        $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:

getDescription()

ilSoapStructureObject::getDescription

(

)

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

References $description.

Referenced by exportXML().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getGotoLink()

ilSoapStructureObject::getGotoLink

(

)

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

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

Referenced by exportXML().

                                 : string
    {
        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:

getInternalLink()

ilSoapStructureObject::getInternalLink

(

)

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

Referenced by exportXML().

                                     : string
    {
        return '';
    }

Here is the caller graph for this function:

getObjId()

ilSoapStructureObject::getObjId

(

)

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

References $obj_id.

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

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getParentRefId()

ilSoapStructureObject::getParentRefId

(

)

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

References $parentRefId.

Referenced by getGotoLink().

                                    : ?int
    {
        return $this->parentRefId;
    }

Here is the caller graph for this function:

getStructureObjects()

ilSoapStructureObject::getStructureObjects

(

)

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

References $structureObjects.

Referenced by exportXML().

                                         : array
    {
        return $this->structureObjects;
    }

Here is the caller graph for this function:

getTitle()

ilSoapStructureObject::getTitle

(

)

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

References $title.

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

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilSoapStructureObject::getType

(

)

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

References $type.

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

                             : string
    {
        return $this->type;
    }

Here is the caller graph for this function:

setDescription()

ilSoapStructureObject::setDescription

(

string

$value

)

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

Referenced by __construct().

                                                 : void
    {
        $this->description = $value;
    }

Here is the caller graph for this function:

setObjId()

ilSoapStructureObject::setObjId

(

int

$value

)

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

Referenced by __construct().

                                        : void
    {
        $this->obj_id = $value;
    }

Here is the caller graph for this function:

setParentRefId()

ilSoapStructureObject::setParentRefId

(

int

$parentRefId

)

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

References $parentRefId.

                                                    : void
    {
        $this->parentRefId = $parentRefId;
    }

setTitle()

ilSoapStructureObject::setTitle

(

string

$value

)

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

Referenced by __construct().

                                           : void
    {
        $this->title = $value;
    }

Here is the caller graph for this function:

setType()

ilSoapStructureObject::setType

(

string

$value

)

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

Referenced by __construct().

                                          : void
    {
        $this->type = $value;
    }

Here is the caller graph for this function:

Field Documentation

$description

string ilSoapStructureObject::$description

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

Referenced by getDescription().

$obj_id

int ilSoapStructureObject::$obj_id

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

Referenced by getObjId().

$parentRefId

int ilSoapStructureObject::$parentRefId

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

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

$structureObjects

array ilSoapStructureObject::$structureObjects = array()

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

Referenced by getStructureObjects().

$title

string ilSoapStructureObject::$title

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

Referenced by getTitle().

$type

string ilSoapStructureObject::$type

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

Referenced by getType().

---

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

• components/ILIAS/soap/classes/class.ilSoapStructureObject.php