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

Inheritance diagram for ilFileXMLWriter:

Collaboration diagram for ilFileXMLWriter:

Public Member Functions
	__construct ()
	constructor More...

	setFile (ilObjFile $file)

	setOmitHeader ($a_val)
	Set omit header. More...

	getOmitHeader ()
	Get omit header. More...

	setFileTargetDirectories (?string $a_rel, ?string $a_abs)
	Set file target directories. More...

	setAttachFileContents (int $attachFileContents)
	set attachment content mode More...

	start ()

	getXML ()

	__buildHeader ()

	__buildFooter ()

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

Data Fields
int	$attachFileContents

ilObjFile	$file
	Exercise Object. More...

	$omit_header = false

Static Public Attributes
static int	$CONTENT_ATTACH_NO = 0

static int	$CONTENT_ATTACH_ENCODED = 1

static int	$CONTENT_ATTACH_ZLIB_ENCODED = 2

static int	$CONTENT_ATTACH_GZIP_ENCODED = 3

static int	$CONTENT_ATTACH_COPY = 4

static int	$CONTENT_ATTACH_REST = 5

Protected Attributes
string	$target_dir_relative = null

string	$target_dir_absolute = 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 class

Class to simplify manual writing of xml documents. It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.

Author: Roland Küstermann Rolan.nosp@m.d@ku.nosp@m.ester.nosp@m.mann.nosp@m..com

Version

Id: class.ilExerciseXMLWriter.php,v 1.3 2005/11/04 12:50:24 smeyer Exp

\

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

Constructor & Destructor Documentation

◆ __construct()

ilFileXMLWriter::__construct ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding

public

Definition at line 65 of file class.ilFileXMLWriter.php.

References $CONTENT_ATTACH_NO, and ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct();
         $this->attachFileContents = ilFileXMLWriter::$CONTENT_ATTACH_NO;
     }

Here is the call graph for this function:

Member Function Documentation

◆ __buildFooter()

ilFileXMLWriter::__buildFooter ( )

Definition at line 230 of file class.ilFileXMLWriter.php.

Referenced by start().

                                    : void
     {
     }

Here is the caller graph for this function:

◆ __buildHeader()

ilFileXMLWriter::__buildHeader ( )

Definition at line 217 of file class.ilFileXMLWriter.php.

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

Referenced by start().

                                    : bool
     {
         if (!$this->getOmitHeader()) {
             $this->xmlSetDtdDef(
                 "<!DOCTYPE File PUBLIC \"-//ILIAS//DTD FileAdministration//EN\" \"" . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_file_3_8.dtd\">"
             );
             $this->xmlSetGenCmt("Exercise Object");
             $this->xmlHeader();
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOmitHeader()

ilFileXMLWriter::getOmitHeader ( )

Get omit header.

Returns: boolean omit header

Definition at line 91 of file class.ilFileXMLWriter.php.

References $omit_header.

Referenced by __buildHeader().

                                    : bool
     {
         return $this->omit_header;
     }

Here is the caller graph for this function:

◆ getXML()

ilFileXMLWriter::getXML ( )

Definition at line 212 of file class.ilFileXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

                             : string
     {
         return $this->xmlDumpMem(false);
     }

Here is the call graph for this function:

◆ setAttachFileContents()

ilFileXMLWriter::setAttachFileContents ( int $attachFileContents )

set attachment content mode

Exceptions

ilExerciseException if mode is not supported

Definition at line 114 of file class.ilFileXMLWriter.php.

References $attachFileContents, $CONTENT_ATTACH_GZIP_ENCODED, $CONTENT_ATTACH_ZLIB_ENCODED, and ilFileException\$ID_DEFLATE_METHOD_MISMATCH.

                                                                   : void
     {
         if ($attachFileContents === ilFileXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED && !function_exists("gzencode")) {
             throw new ilFileException(
                 "Inflating with gzip is not supported",
                 ilFileException::$ID_DEFLATE_METHOD_MISMATCH
             );
         }
         if ($attachFileContents === ilFileXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED && !function_exists("gzcompress")) {
             throw new ilFileException(
                 "Inflating with zlib (compress/uncompress) is not supported",
                 ilFileException::$ID_DEFLATE_METHOD_MISMATCH
             );
         }
         $this->attachFileContents = $attachFileContents;
     }

◆ setFile()

ilFileXMLWriter::setFile ( ilObjFile $file )

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

References $file.

                                             : void
     {
         $this->file = &$file;
     }

◆ setFileTargetDirectories()

ilFileXMLWriter::setFileTargetDirectories	(	?string	$a_rel,
		?string	$a_abs
	)

Set file target directories.

Parameters

string	relative file target directory
string	absolute file target directory

Definition at line 102 of file class.ilFileXMLWriter.php.

Referenced by ilFileExporter\prepareExportDirectories().

                                                                             : void
     {
         $this->target_dir_relative = $a_rel;
         $this->target_dir_absolute = $a_abs;
     }

Here is the caller graph for this function:

◆ setOmitHeader()

ilFileXMLWriter::setOmitHeader ( $a_val )

Set omit header.

Parameters

boolean omit header

Definition at line 81 of file class.ilFileXMLWriter.php.

                                          : void
     {
         $this->omit_header = $a_val;
     }

◆ start()

ilFileXMLWriter::start ( )

Definition at line 131 of file class.ilFileXMLWriter.php.

References $CONTENT_ATTACH_COPY, $CONTENT_ATTACH_GZIP_ENCODED, $CONTENT_ATTACH_REST, $CONTENT_ATTACH_ZLIB_ENCODED, $filename, ilXmlWriter\$version, __buildFooter(), __buildHeader(), IL_INST_ID, null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                            : bool
     {
         $this->__buildHeader();
 
         $attribs = [
             "obj_id" => "il_" . IL_INST_ID . "_file_" . $this->file->getId(),
             "version" => $this->file->getVersion(),
             "max_version" => $this->file->getMaxVersion(),
             "size" => $this->file->getFileSize(),
             "type" => $this->file->getFileType(),
             "action" => $this->file->getAction()
         ];
 
         $this->xmlStartTag("File", $attribs);
         $this->xmlElement("Filename", null, $this->file->getFileName());
 
         $this->xmlElement("Title", null, $this->file->getTitle());
         $this->xmlElement("Description", null, $this->file->getDescription());
         $this->xmlElement("Rating", null, (int) $this->file->hasRating());
 
         $versions = $this->file->getVersions();
 
         if ($versions !== []) {
             $this->xmlStartTag("Versions");
 
             foreach ($versions as $version) {
                 $attribs = [
                     "version" => $version["version"],
                     "max_version" => $version["max_version"],
                     "date" => strtotime((string) $version["date"]),
                     "usr_id" => "il_" . IL_INST_ID . "_usr_" . $version["user_id"],
                     "action" => $version["action"],
                     "rollback_version" => $version["rollback_version"],
                     "rollback_user_id" => $version["rollback_user_id"]
                 ];
 
                 $content = "";
 
                 if ($this->attachFileContents !== 0) {
                     $filename = $this->file->getFile($version["version"]);
 
                     if (@is_file($filename)) {
                         if ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_COPY) {
                             $attribs ["mode"] = "COPY";
                             $content = "/" . $version["version"] . "_" . $this->file->getFileName();
                             copy($filename, $this->target_dir_absolute . $content);
                             $content = $this->target_dir_relative . $content;
                         } // begin-patch fm
                         elseif ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_REST) {
                             $attribs ['mode'] = "REST";
                             $fs = new ilRestFileStorage();
                             $content = $fs->storeFileForRest(base64_encode(@file_get_contents($filename)));
                             ;
                         } // end-patch fm
                         else {
                             $content = @file_get_contents($filename);
                             $attribs ["mode"] = "PLAIN";
                             if ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED) {
                                 $attribs ["mode"] = "ZLIB";
                                 $content = @gzcompress($content, 9);
                             } elseif ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED) {
                                 $attribs ["mode"] = "GZIP";
                                 $content = @gzencode($content, 9);
                             }
                             $content = base64_encode($content);
                         }
                     }
                 }
 
                 $this->xmlElement("Version", $attribs, $content);
             }
             $this->xmlEndTag("Versions");
         }
 
         $this->xmlEndTag("File");
 
         $this->__buildFooter();
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $attachFileContents

int ilFileXMLWriter::$attachFileContents

Definition at line 44 of file class.ilFileXMLWriter.php.

Referenced by setAttachFileContents().

◆ $CONTENT_ATTACH_COPY

int ilFileXMLWriter::$CONTENT_ATTACH_COPY = 4

static

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

Referenced by ilFileExporter\getXmlRepresentation(), and start().

◆ $CONTENT_ATTACH_ENCODED

int ilFileXMLWriter::$CONTENT_ATTACH_ENCODED = 1

static

Definition at line 36 of file class.ilFileXMLWriter.php.

◆ $CONTENT_ATTACH_GZIP_ENCODED

int ilFileXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED = 3

static

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

Referenced by setAttachFileContents(), and start().

◆ $CONTENT_ATTACH_NO

int ilFileXMLWriter::$CONTENT_ATTACH_NO = 0

static

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

Referenced by __construct().

◆ $CONTENT_ATTACH_REST

int ilFileXMLWriter::$CONTENT_ATTACH_REST = 5

static

Definition at line 41 of file class.ilFileXMLWriter.php.

Referenced by start().

◆ $CONTENT_ATTACH_ZLIB_ENCODED

int ilFileXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED = 2

static

Definition at line 37 of file class.ilFileXMLWriter.php.

Referenced by setAttachFileContents(), and start().

◆ $file

ilObjFile ilFileXMLWriter::$file

Exercise Object.

Definition at line 48 of file class.ilFileXMLWriter.php.

Referenced by setFile().

◆ $omit_header

ilFileXMLWriter::$omit_header = false

Definition at line 52 of file class.ilFileXMLWriter.php.

Referenced by getOmitHeader().

◆ $target_dir_absolute

string ilFileXMLWriter::$target_dir_absolute = null

protected

Definition at line 54 of file class.ilFileXMLWriter.php.

◆ $target_dir_relative

string ilFileXMLWriter::$target_dir_relative = null

protected

Definition at line 53 of file class.ilFileXMLWriter.php.

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

components/ILIAS/File/classes/class.ilFileXMLWriter.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __buildFooter()

◆ __buildHeader()

◆ getOmitHeader()

◆ getXML()

◆ setAttachFileContents()

◆ setFile()

◆ setFileTargetDirectories()

◆ setOmitHeader()

◆ start()

Field Documentation

◆ $attachFileContents

◆ $CONTENT_ATTACH_COPY

◆ $CONTENT_ATTACH_ENCODED

◆ $CONTENT_ATTACH_GZIP_ENCODED

◆ $CONTENT_ATTACH_NO

◆ $CONTENT_ATTACH_REST

◆ $CONTENT_ATTACH_ZLIB_ENCODED

◆ $file

◆ $omit_header

◆ $target_dir_absolute

◆ $target_dir_relative