This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilWebLinkXmlWriter:

Collaboration diagram for ilWebLinkXmlWriter:

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 = true

int	$obj_id = 0

ilObjLinkResource	$weblink = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning XML writer for weblinks

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

Constructor & Destructor Documentation

◆ __construct()

ilWebLinkXmlWriter::__construct ( bool $a_add_header )

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

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

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ buildHeader()

ilWebLinkXmlWriter::buildHeader ( )

protected

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

                                    : bool
    {
        $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

Exceptions

UnexpectedValueException Thrown if obj_id is not of type webr

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

                             : void
    {
        $this->xmlClear();
 
        if (!$this->obj_id) {
            throw new UnexpectedValueException('No obj_id given: ');
        }
        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 ( int $a_obj_id )

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

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

◆ write()

ilWebLinkXmlWriter::write ( )

Exceptions

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

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

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