ilFolderXmlWriter Class Reference

XML writer for folders. More...

Inheritance diagram for ilFolderXmlWriter:

Collaboration diagram for ilFolderXmlWriter:

Public Member Functions
	__construct (bool $a_add_header)
	setObjId (int $a_obj_id)
	write ()
Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")
	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...
	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...
	xmlFormatData (string $data)
	Indents text for better reading. More...
	xmlHeader ()
	Writes xml header. More...
	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...
	xmlEndTag (string $tag)
	Writes an endtag. More...
	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...
	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...
	appendXML (string $a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr More...

Protected Member Functions
	buildHeader ()
	init ()

Private Attributes
bool	$add_header
int	$obj_id = 0
ilObject	$folder = null

Detailed Description

XML writer for folders.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilFolderXmlWriter::__construct

(

bool

$a_add_header

)

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        $this->add_header = $a_add_header;
        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

buildHeader()

ilFolderXmlWriter::buildHeader ( )

protected

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

References ilXmlWriter\xmlHeader(), and ilXmlWriter\xmlSetGenCmt().

Referenced by write().

                                    : void
    {
        $this->xmlSetGenCmt("Export of a ILIAS Folder");
        $this->xmlHeader();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilFolderXmlWriter::init ( )

protected

Definition at line 62 of file class.ilFolderXmlWriter.php.

References ilObjectFactory\getInstanceByObjId(), and ilXmlWriter\xmlClear().

Referenced by write().

                             : void
    {
        $this->xmlClear();

        if (!$this->obj_id) {
            throw new UnexpectedValueException('No obj_id given: ');
        }
        if (!$this->folder = ilObjectFactory::getInstanceByObjId($this->obj_id, false)) {
            throw new UnexpectedValueException('Invalid obj_id given: ' . $this->obj_id);
        }
        if ($this->folder->getType() !== 'fold') {
            throw new UnexpectedValueException('Invalid obj_id given. Object is not of type folder');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setObjId()

ilFolderXmlWriter::setObjId

(

int

$a_obj_id

)

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

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

write()

ilFolderXmlWriter::write

(

)

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

References ilContainerSortingSettings\_exportContainerSortingSettings(), buildHeader(), init(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                           : void
    {
        $this->init();
        if ($this->add_header) {
            $this->buildHeader();
        }
        $this->xmlStartTag('Folder', ['Id' => $this->folder->getId()]);
        $this->xmlElement('Title', [], $this->folder->getTitle());
        $this->xmlElement('Description', [], $this->folder->getDescription());
        ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->obj_id);
        $this->xmlEndTag('Folder');
    }

Here is the call graph for this function:

Field Documentation

$add_header

bool ilFolderXmlWriter::$add_header

private

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

$folder

ilObject ilFolderXmlWriter::$folder = null

private

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

$obj_id

int ilFolderXmlWriter::$obj_id = 0

private

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

---

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

• components/ILIAS/Folder/classes/class.ilFolderXmlWriter.php