ilGlossaryExport Class Reference

Export class for content objects. More...

Collaboration diagram for ilGlossaryExport:

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

Data Fields
	$err
	$db
	$glo_obj
	$inst_id

Protected Attributes
	$settings

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$

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

References $DIC, $ilDB, $ilErr, $ilSetting, $settings, settings(), and time.

    {
        global $DIC;

        $this->settings = $DIC->settings();
        $ilErr = $DIC["ilErr"];
        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();

        $this->glo_obj = $a_glo_obj;

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

        $settings = $ilSetting->getAll();
        // 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;

        }
    }

Here is the call graph for this function:

Member Function Documentation

buildExportFile()

ilGlossaryExport::buildExportFile

(

)

build export file (complete zip file)

public

Returns

Definition at line 99 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:

buildExportFileHTML()

ilGlossaryExport::buildExportFileHTML

(

)

build html export file

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

Referenced by buildExportFile().

    {
        // 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:

buildExportFileXML()

ilGlossaryExport::buildExportFileXML

(

)

build export file (complete zip file)

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

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

Referenced by 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();
        include_once './Services/Logging/classes/class.ilLog.php';
        $expLog = new ilLog($expDir, "export.log");
        $expLog->delete();
        $expLog->setLogFormat("");
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export");

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



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

        // zip the file
        ilUtil::zip(
            $this->export_dir . "/" . $this->subdir,
            $this->export_dir . "/" . $this->subdir . ".zip"
        );

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getInstId()

ilGlossaryExport::getInstId

(

)

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

References $inst_id.

    {
        return $this->inst_id;
    }

Field Documentation

$db

ilGlossaryExport::$db

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

$err

ilGlossaryExport::$err

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

$glo_obj

ilGlossaryExport::$glo_obj

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

$inst_id

ilGlossaryExport::$inst_id

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

Referenced by getInstId().

$settings

ilGlossaryExport::$settings

protected

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

Referenced by __construct().

---

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

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