ilWebLinkXmlWriter Class Reference

XML writer for weblinks. More...

Inheritance diagram for ilWebLinkXmlWriter:

Collaboration diagram for ilWebLinkXmlWriter:

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
	$weblink = 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 weblinks.

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.ilWebLinkXmlWriter.php.

Constructor & Destructor Documentation

__construct()

ilWebLinkXmlWriter::__construct

(

$a_add_header

)

Constructor.

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

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

Member Function Documentation

buildHeader()

ilWebLinkXmlWriter::buildHeader ( )

protected

Build XML header.

Returns

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

    {
        $this->xmlSetDtdDef("<!DOCTYPE WebLinks PUBLIC \"-//ILIAS//DTD WebLinkAdministration//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_weblinks_5_1.dtd\">");
        $this->xmlSetGenCmt("WebLink Object");
        $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()

ilWebLinkXmlWriter::init ( )

protected

Init xml writer.

Returns

bool

Exceptions

UnexpectedValueException

Thrown if obj_id is not of type webr

Definition at line 73 of file class.ilWebLinkXmlWriter.php.

    {
        $this->xmlClear();
        
        if (!$this->obj_id) {
            throw new UnexpectedValueException('No obj_id given: ');
        }
        include_once './Services/Object/classes/class.ilObjectFactory.php';
        if (!$this->weblink = ilObjectFactory::getInstanceByObjId($this->obj_id, false)) {
            throw new UnexpectedValueException('Invalid obj_id given: ' . $this->obj_id);
        }
        if ($this->weblink->getType() != 'webr') {
            throw new UnexpectedValueException('Invalid obj_id given. Object is not of type webr');
        }
    }

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()

ilWebLinkXmlWriter::setObjId

(

$a_obj_id

)

Set obj_id of weblink object.

Parameters

int

obj_id

Returns

bool

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

    {
        $this->obj_id = $a_obj_id;
    }

write()

ilWebLinkXmlWriter::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.ilWebLinkXmlWriter.php.

    {
        $this->init();
        if ($this->add_header) {
            $this->buildHeader();
        }
        $this->weblink->toXML($this);
    }

References buildHeader(), and init().

Here is the call graph for this function:

Field Documentation

$add_header

ilWebLinkXmlWriter::$add_header = true

private

Definition at line 16 of file class.ilWebLinkXmlWriter.php.

$obj_id

ilWebLinkXmlWriter::$obj_id = 0

private

Definition at line 18 of file class.ilWebLinkXmlWriter.php.

$weblink

ilWebLinkXmlWriter::$weblink = null

private

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

---

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

• Modules/WebResource/classes/class.ilWebLinkXmlWriter.php