Abstract classs for reading structure objects. More...

Inheritance diagram for ilSoapStructureReader:

Collaboration diagram for ilSoapStructureReader:

Public Member Functions
	__construct (ilObject $object)

	getStructureObject ()

	_parseStructure ()

	isValid ()

	getObject ()

Data Fields
ilSoapStructureObject	$structureObject = null

Protected Attributes
ilObject	$object

Detailed Description

Abstract classs for reading 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 8 of file class.ilSoapStructureReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilSoapStructureReader::__construct ( ilObject $object )

Definition at line 13 of file class.ilSoapStructureReader.php.

    {
        $this->object = $object;
        $this->structureObject = ilSoapStructureObjectFactory::getInstanceForObject($object);
    }

References $object, and ilSoapStructureObjectFactory\getInstanceForObject().

Here is the call graph for this function:

Member Function Documentation

◆ _parseStructure()

ilSoapStructureReader::_parseStructure ( )

Reimplemented in ilSoapGLOStructureReader.

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

                                      : void
    {
    }

Referenced by getStructureObject().

Here is the caller graph for this function:

◆ getObject()

ilSoapStructureReader::getObject ( )

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

                                : ilObject
    {
        return $this->object;
    }

References $object.

Referenced by ilSoapGLOStructureReader\_parseStructure().

Here is the caller graph for this function:

◆ getStructureObject()

ilSoapStructureReader::getStructureObject ( )

Definition at line 19 of file class.ilSoapStructureReader.php.

                                         : ?ilSoapStructureObject
    {
        $this->_parseStructure();
        return $this->structureObject;
    }

References $structureObject, and _parseStructure().

Here is the call graph for this function:

◆ isValid()

ilSoapStructureReader::isValid ( )

Definition at line 29 of file class.ilSoapStructureReader.php.

                              : bool
    {
        return $this->structureObject instanceof \ilSoapStructureObject;
    }

Field Documentation

◆ $object

ilObject ilSoapStructureReader::$object

protected

Definition at line 10 of file class.ilSoapStructureReader.php.

Referenced by __construct(), ilSoapGLOStructureReader\_parseStructure(), and getObject().

◆ $structureObject

ilSoapStructureObject ilSoapStructureReader::$structureObject = null

Definition at line 11 of file class.ilSoapStructureReader.php.