ilGlossaryExport Class Reference

Export class for content objects. More...

Collaboration diagram for ilGlossaryExport:

Public Member Functions
	ilGlossaryExport (&$a_glo_obj, $a_mode="xml")
	Constructor public.
	getInstId ()
	buildExportFile ()
	build export file (complete zip file)
	buildExportFileXML ()
	build export file (complete zip file)
	buildExportFileHTML ()
	build html export file

Data Fields
	$err
	$db
	$ilias
	$glo_obj
	$inst_id

Detailed Description

Export class for content objects.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

Id:

class.ilGlossaryExport.php 29958 2011-07-20 12:08:00Z smeyer

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

Member Function Documentation

ilGlossaryExport::buildExportFile

(

)

build export file (complete zip file)

public

Returns

Definition at line 163 of file class.ilGlossaryExport.php.

References buildExportFileHTML(), and buildExportFileXML().

        {
                switch ($this->mode)
                {
                        case "html":
                                return $this->buildExportFileHTML();
                                break;

                        default:
                                return $this->buildExportFileXML();
                                break;
                }
        }

Here is the call graph for this function:

ilGlossaryExport::buildExportFileHTML

(

)

build html export file

Definition at line 251 of file class.ilGlossaryExport.php.

References $ilBench.

Referenced by buildExportFile().

        {
                global $ilBench;

                // create directories
                $this->glo_obj->createExportDirectory("html");

                // get Log File
                $expDir = $this->glo_obj->getExportDirectory();

                // get xml content
                $this->glo_obj->exportHTML($this->export_dir."/".$this->subdir, $expLog);
        }

Here is the caller graph for this function:

ilGlossaryExport::buildExportFileXML

(

)

build export file (complete zip file)

Definition at line 180 of file class.ilGlossaryExport.php.

References $ilBench, ilUtil\makeDir(), ilXmlWriter\xmlSetDtdDef(), and ilUtil\zip().

Referenced by buildExportFile().

        {
                global $ilBench;

                $ilBench->start("GlossaryExport", "buildExportFile");

                require_once("./Services/Xml/classes/class.ilXmlWriter.php");

                $this->xml = new ilXmlWriter;

                // set dtd definition
                $this->xml->xmlSetDtdDef("<!DOCTYPE ContentObject SYSTEM \"http://www.ilias.uni-koeln.de/download/dtd/ilias_co_3_7.dtd\">");

                // set generated comment
                $this->xml->xmlSetGenCmt("Export of ILIAS Glossary ".
                        $this->glo_obj->getId()." of installation ".$this->inst.".");

                // set xml header
                $this->xml->xmlHeader();

                // create directories
                $this->glo_obj->createExportDirectory();
                ilUtil::makeDir($this->export_dir."/".$this->subdir);
                ilUtil::makeDir($this->export_dir."/".$this->subdir."/objects");

                // get Log File
                $expDir = $this->glo_obj->getExportDirectory();
                $expLog = new ilLog($expDir, "export.log");
                $expLog->delete();
                $expLog->setLogFormat("");
                $expLog->write(date("[y-m-d H:i:s] ")."Start Export");

                // get xml content
//echo "ContObjExport:".$this->inst_id.":<br>";
                $ilBench->start("GlossaryExport", "buildExportFile_getXML");
                $this->glo_obj->exportXML($this->xml, $this->inst_id,
                        $this->export_dir."/".$this->subdir, $expLog);
                $ilBench->stop("GlossaryExport", "buildExportFile_getXML");

                // dump xml document to screen (only for debugging reasons)
                /*
                echo "<PRE>";
                echo htmlentities($this->xml->xmlDumpMem($format));
                echo "</PRE>";
                */


                // dump xml document to file
                $ilBench->start("GlossaryExport", "buildExportFile_dumpToFile");
                $this->xml->xmlDumpFile($this->export_dir."/".$this->subdir."/".$this->filename
                        , false);
                $ilBench->stop("GlossaryExport", "buildExportFile_dumpToFile");

                // zip the file
                $ilBench->start("GlossaryExport", "buildExportFile_zipFile");
                ilUtil::zip($this->export_dir."/".$this->subdir,
                        $this->export_dir."/".$this->subdir.".zip");
                $ilBench->stop("GlossaryExport", "buildExportFile_zipFile");

                // destroy writer object
                $this->xml->_XmlWriter;

                $expLog->write(date("[y-m-d H:i:s] ")."Finished Export");
                $ilBench->stop("GlossaryExport", "buildExportFile");

                return $this->export_dir."/".$this->subdir.".zip";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilGlossaryExport::getInstId

(

)

Definition at line 82 of file class.ilGlossaryExport.php.

References $inst_id.

        {
                return $this->inst_id;
        }

ilGlossaryExport::ilGlossaryExport	(	&	$a_glo_obj,
			$a_mode = "xml"
	)

Constructor public.

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

References $ilErr, and $ilias.

        {
                global $ilErr, $ilDB, $ilias;

                $this->glo_obj =& $a_glo_obj;

                $this->err =& $ilErr;
                $this->ilias =& $ilias;
                $this->db =& $ilDB;
                $this->mode = $a_mode;

                $settings = $this->ilias->getAllSettings();
                // The default '0' is required for the directory structure (smeyer)
                $this->inst_id = $settings["inst_id"] ? $settings['inst_id'] : 0;

                $date = time();
                switch($this->mode)
                {
                        case "xml":
                                $this->export_dir = $this->glo_obj->getExportDirectory();
                                $this->subdir = $date."__".$this->inst_id."__".
                                        $this->glo_obj->getType()."_".$this->glo_obj->getId();
                                $this->filename = $this->subdir.".xml";
                                break;
                
                        case "html":
                                $this->export_dir = $this->glo_obj->getExportDirectory("html");
                                $this->subdir = $this->glo_obj->getType()."_".$this->glo_obj->getId();
                                $this->filename = $this->subdir.".zip";
                                break;

                }

        }

Field Documentation

ilGlossaryExport::$db

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

ilGlossaryExport::$err

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

ilGlossaryExport::$glo_obj

Definition at line 40 of file class.ilGlossaryExport.php.

ilGlossaryExport::$ilias

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

Referenced by ilGlossaryExport().

ilGlossaryExport::$inst_id

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

Referenced by getInstId().

---

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

• Modules/Glossary/classes/class.ilGlossaryExport.php