XML writer for folders. More...

Inheritance diagram for ilFolderXmlWriter:

Collaboration diagram for ilFolderXmlWriter:

Public Member Functions
	__construct ($a_add_header)
	Constructor. More...

	setObjId ($a_obj_id)
	Set obj_id of weblink object. More...

	write ()
	Write XML. More...

Public Member Functions inherited from ilXmlWriter
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...

	_ilXmlWriter ()
	destructor @access public More...

	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...

	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...

	xmlSetGenCmt ($genCmt)
	Sets generated comment. More...

	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...

	xmlFormatData ($data)
	Indents text for better reading. More...

	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...

	xmlHeader ()
	Writes xml header @access public. More...

	xmlStartTag ($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
	Writes a starttag. More...

	xmlEndTag ($tag)
	Writes an endtag. More...

	xmlComment ($comment)
	Writes a comment. More...

	xmlData ($data, $encode=true, $escape=true)
	Writes data. More...

	xmlElement ($tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile ($file, $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem ($format=true)
	Returns xml document from memory. More...

	appendXML ($a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr @access public More...

Protected Member Functions
	buildHeader ()
	Build XML header. More...

	init ()
	Init xml writer. More...

Private Attributes
	$add_header = true

	$obj_id = 0

	$folder = null

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilFolderXmlWriter::__construct ( $a_add_header )

Constructor.

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

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

Member Function Documentation

◆ buildHeader()

ilFolderXmlWriter::buildHeader ( )

protected

Build XML header.

Returns

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

    {
        $this->xmlSetDtdDef("<!DOCTYPE WebLinks PUBLIC \"-//ILIAS//DTD WebLinkAdministration//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_fold_4_5.dtd\">");
        $this->xmlSetGenCmt("Export of a ILIAS Folder");
        $this->xmlHeader();
 
        return true;
    }

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

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilFolderXmlWriter::init ( )

protected

Init xml writer.

Returns: bool

Exceptions

UnexpectedValueException Thrown if obj_id is not of type webr

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

    {
        $this->xmlClear();
        
        if (!$this->obj_id) {
            throw new UnexpectedValueException('No obj_id given: ');
        }
        include_once './Services/Object/classes/class.ilObjectFactory.php';
        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');
        }
    }

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

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjId()

ilFolderXmlWriter::setObjId ( $a_obj_id )

Set obj_id of weblink object.

Parameters

int obj_id

Returns: bool

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

    {
        $this->obj_id = $a_obj_id;
    }

◆ write()

ilFolderXmlWriter::write ( )

Write XML.

Returns

Exceptions

UnexpectedValueException Thrown if obj_id is not of type webr or no obj_id is given

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

    {
        $this->init();
        if ($this->add_header) {
            $this->buildHeader();
        }
        $this->xmlStartTag('Folder', array('Id' => $this->folder->getId()));
        $this->xmlElement('Title', array(), $this->folder->getTitle());
        $this->xmlElement('Description', array(), $this->folder->getDescription());
        include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
        ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->obj_id);
        $this->xmlEndTag('Folder');
    }