ilGlossaryExport Class Reference

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

Collaboration diagram for ilGlossaryExport:

Public Member Functions
	__construct (ilObjGlossary $a_glo_obj, string $a_mode="xml")
	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
ilDBInterface	$db
ilObjGlossary	$glo_obj
int	$inst_id

Protected Attributes
ilXmlWriter	$xml
string	$export_dir
string	$filename
string	$subdir
string	$mode
ilSetting	$settings

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 Export class for content objects

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, $ilDB, $ilSetting, and ILIAS\Repository\settings().

      {
        global $DIC;

        $this->settings = $DIC->settings();
        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        $this->glo_obj = $a_glo_obj;
        $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)

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

References buildExportFileHTML(), and buildExportFileXML().

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

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

Here is the call graph for this function:

buildExportFileHTML()

ilGlossaryExport::buildExportFileHTML

(

)

build html export file

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

Referenced by buildExportFile().

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

        // get html content
        $exp = new \ILIAS\Glossary\Export\GlossaryHtmlExport(
            $this->glo_obj,
            $this->export_dir,
            $this->subdir
        );
        return $exp->exportHTML();
    }

Here is the caller graph for this function:

buildExportFileXML()

ilGlossaryExport::buildExportFileXML

(

)

build export file (complete zip file)

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

References ilFileUtils\makeDir(), and ilFileUtils\zip().

Referenced by buildExportFile().

                                        : string
    {
        $this->xml = new ilXmlWriter();

        // set dtd definition
        $this->xml->xmlSetDtdDef("<!DOCTYPE ContentObject SYSTEM \"https://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_id . ".");

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

        // create directories
        $this->glo_obj->createExportDirectory();
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir);
        ilFileUtils::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
        $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
        ilFileUtils::zip(
            $this->export_dir . "/" . $this->subdir,
            $this->export_dir . "/" . $this->subdir . ".zip"
        );

        $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 71 of file class.ilGlossaryExport.php.

References $inst_id.

                               : int
    {
        return $this->inst_id;
    }

Field Documentation

$db

ilDBInterface ilGlossaryExport::$db

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

$export_dir

string ilGlossaryExport::$export_dir

protected

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

$filename

string ilGlossaryExport::$filename

protected

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

$glo_obj

ilObjGlossary ilGlossaryExport::$glo_obj

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

$inst_id

int ilGlossaryExport::$inst_id

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

Referenced by getInstId().

$mode

string ilGlossaryExport::$mode

protected

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

$settings

ilSetting ilGlossaryExport::$settings

protected

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

$subdir

string ilGlossaryExport::$subdir

protected

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

$xml

ilXmlWriter ilGlossaryExport::$xml

protected

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

---

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

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