XML writer class. More...

Inheritance diagram for ilFileXMLWriter:

Collaboration diagram for ilFileXMLWriter:

Public Member Functions
	ilFileXMLWriter ()
	constructor More...

	setFile (ilObjFile $file)

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

	getOmitHeader ()
	Get omit header. More...

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

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

	start ()

	getXML ()

	__buildHeader ()

	__buildFooter ()

Public Member Functions inherited from ilXmlWriter
	ilXmlWriter ($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...

	_xmlEscapeData ($data)
	Escapes reserved characters. 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...

Data Fields
	$attachFileContents

	$file

	$omit_header = false

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

Static Public Attributes
static	$CONTENT_ATTACH_NO = 0

static	$CONTENT_ATTACH_ENCODED = 1

static	$CONTENT_ATTACH_ZLIB_ENCODED = 2

static	$CONTENT_ATTACH_GZIP_ENCODED = 3

static	$CONTENT_ATTACH_COPY = 4

static	$CONTENT_ATTACH_REST = 5

Detailed Description

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 21 of file class.ilFileXMLWriter.php.

Member Function Documentation

◆ __buildFooter()

ilFileXMLWriter::__buildFooter ( )

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

        {
 
        }

Referenced by start().

Here is the caller graph for this function:

◆ __buildHeader()

ilFileXMLWriter::__buildHeader ( )

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

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

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

Referenced by start().

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 84 of file class.ilFileXMLWriter.php.

        {
                return $this->omit_header;
        }

References $omit_header.

Referenced by __buildHeader().

Here is the caller graph for this function:

◆ getXML()

ilFileXMLWriter::getXML ( )

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

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

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ ilFileXMLWriter()

ilFileXMLWriter::ilFileXMLWriter ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding @access public

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

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

References $CONTENT_ATTACH_NO.

◆ setAttachFileContents()

ilFileXMLWriter::setAttachFileContents ( $attachFileContents )

set attachment content mode

Parameters

int $attachFileContents

Exceptions

ilExerciseException if mode is not supported

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

        {
                 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;
        }

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

◆ setFile()

ilFileXMLWriter::setFile ( ilObjFile $file )

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

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

References $file.

◆ setFileTargetDirectories()

ilFileXMLWriter::setFileTargetDirectories	(	$a_rel,
		$a_abs
	)

Set file target directories.

Parameters

string	relative file target directory
string	absolute file target directory

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

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

◆ setOmitHeader()

ilFileXMLWriter::setOmitHeader ( $a_val )

Set omit header.

Parameters

boolean omit header

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

        {
                $this->omit_header = $a_val;
        }

◆ start()

ilFileXMLWriter::start ( )

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

        {
                $this->__buildHeader();
 
                $attribs =array (
                  "obj_id" => "il_".IL_INST_ID."_file_".$this->file->getId(),
                  "version" => $this->file->getVersion(),
                  "size" => $this->file->getFileSize(),
                  "type" => $this->file->getFileType()
                );
 
        $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());
 
        if ($this->attachFileContents)
        {
            $filename = $this->file->getDirectory($this->file->getVersion())."/".$this->file->getFileName();
            if (@is_file($filename))
            {
                                if ($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_COPY)
                                {
                                        $attribs = array("mode" =>"COPY");
                                        copy($filename, $this->target_dir_absolute."/".$this->file->getFileName());
                                        $content = $this->target_dir_relative."/".$this->file->getFileName();
                                        $this->xmlElement("Content",$attribs, $content);
                                }
                                // begin-patch fm
                                elseif($this->attachFileContents == ilFileXMLWriter::$CONTENT_ATTACH_REST)
                                {
                                        $attribs = array('mode' => "REST");
                                        include_once './Services/WebServices/Rest/classes/class.ilRestFileStorage.php';
                                        $fs = new ilRestFileStorage();
                                        $tmpname = $fs->storeFileForRest(base64_encode(@file_get_contents($filename)));
                                        $this->xmlElement("Content",$attribs, $tmpname);
                                }
                                // end-patch fm
                                else
                                {
                                        $content = @file_get_contents($filename);
                                        $attribs = array("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("Content",$attribs, $content);
                                }
            }
 
        }
 
        include_once("./Services/History/classes/class.ilHistory.php");
 
                $versions = ilHistory::_getEntriesForObject($this->file->getId(), $this->file->getType());
 
                if (count($versions)) {
                    $this->xmlStartTag("Versions");
                    foreach ($versions as $version) {
                        $info_params = $version["info_params"];
                        list($filename,$history_id) = split(",",$info_params);
                        $attribs = array (
                          "id" => $history_id,
                          "date" => ilUtil::date_mysql2time($version["date"]),
                          "usr_id" => "il_".IL_INST_ID."_usr_".$version["user_id"]
                        );
                        $this->xmlElement("Version", $attribs);
                    }
            $this->xmlEndTag("Versions");
 
                }
 
        $this->xmlEndTag("File");
 
                $this->__buildFooter();
 
                return true;
        }

References $CONTENT_ATTACH_COPY, $CONTENT_ATTACH_GZIP_ENCODED, $CONTENT_ATTACH_REST, $CONTENT_ATTACH_ZLIB_ENCODED, $filename, ilXmlWriter\$version, __buildFooter(), __buildHeader(), ilHistory\_getEntriesForObject(), ilUtil\date_mysql2time(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

Field Documentation

◆ $attachFileContents

ilFileXMLWriter::$attachFileContents

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

Referenced by setAttachFileContents().

◆ $CONTENT_ATTACH_COPY

ilFileXMLWriter::$CONTENT_ATTACH_COPY = 4

static

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

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

◆ $CONTENT_ATTACH_ENCODED

ilFileXMLWriter::$CONTENT_ATTACH_ENCODED = 1

static

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

◆ $CONTENT_ATTACH_GZIP_ENCODED

ilFileXMLWriter::$CONTENT_ATTACH_GZIP_ENCODED = 3

static

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

Referenced by setAttachFileContents(), and start().

◆ $CONTENT_ATTACH_NO

ilFileXMLWriter::$CONTENT_ATTACH_NO = 0

static

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

Referenced by ilFileXMLWriter().

◆ $CONTENT_ATTACH_REST

ilFileXMLWriter::$CONTENT_ATTACH_REST = 5

static

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

Referenced by start().

◆ $CONTENT_ATTACH_ZLIB_ENCODED

ilFileXMLWriter::$CONTENT_ATTACH_ZLIB_ENCODED = 2

static

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

Referenced by setAttachFileContents(), and start().

◆ $file

ilFileXMLWriter::$file

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

Referenced by setFile().

◆ $omit_header

ilFileXMLWriter::$omit_header = false

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

Referenced by getOmitHeader().

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

Modules/File/classes/class.ilFileXMLWriter.php

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Member Function Documentation

◆ __buildFooter()

◆ __buildHeader()

◆ getOmitHeader()

◆ getXML()

◆ ilFileXMLWriter()

◆ 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