ilSoapRepositoryStructureObject Class Reference

Inheritance diagram for ilSoapRepositoryStructureObject:

Collaboration diagram for ilSoapRepositoryStructureObject:

Public Member Functions
	__construct (int $objId, string $type, string $title, string $description, ?int $refId=null)
	setRefId (int $value)
	getRefId ()
	getInternalLink ()
	getGotoLink ()
	_getXMLAttributes ()
	_getTagName ()
Public Member Functions inherited from ilSoapStructureObject
	__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)

Protected Attributes
int	$ref_id = 0

Additional Inherited Members
Data Fields inherited from ilSoapStructureObject
int	$obj_id
string	$title
string	$type
string	$description
int	$parentRefId
array	$structureObjects = array()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSoapRepositoryStructureObject::__construct	(	int	$objId,
		string	$type,
		string	$title,
		string	$description,
		?int	$refId = null
	)

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

References $refId, ILIAS\GlobalScreen\Provider\__construct(), and setRefId().

    {
        parent::__construct($objId, $type, $title, $description);
        $this->setRefId($refId);
    }

Here is the call graph for this function:

Member Function Documentation

_getTagName()

ilSoapRepositoryStructureObject::_getTagName

(

)

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

                                 : string
    {
        return "RepositoryObject";
    }

_getXMLAttributes()

ilSoapRepositoryStructureObject::_getXMLAttributes

(

)

Returns

array{type: string, ref_id: int, obj_id: int}

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

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

                                       : array
    {
        return [
            'type' => $this->getType(),
            'obj_id' => $this->getObjId(),
            'ref_id' => $this->getRefId()
        ];
    }

Here is the call graph for this function:

getGotoLink()

ilSoapRepositoryStructureObject::getGotoLink

(

)

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

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

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

Here is the call graph for this function:

getInternalLink()

ilSoapRepositoryStructureObject::getInternalLink

(

)

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

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

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

Here is the call graph for this function:

getRefId()

ilSoapRepositoryStructureObject::getRefId

(

)

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

References $ref_id.

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

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

setRefId()

ilSoapRepositoryStructureObject::setRefId

(

int

$value

)

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

Referenced by __construct().

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

Here is the caller graph for this function:

Field Documentation

$ref_id

int ilSoapRepositoryStructureObject::$ref_id = 0

protected

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

Referenced by getRefId().

---

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

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