ilContObjectExport 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 ilContObjectExport:

Public Member Functions
	__construct (ilObjLearningModule $a_cont_obj, string $a_mode="xml", string $a_lang="")
	getInstId ()
	buildExportFile (string $a_mode="")
	buildExportFileXML (string $a_mode="")
	build xml export file More...
	buildExportFileHTML ()

Data Fields
ilDBInterface	$db
ilObjLearningModule	$cont_obj
int	$inst_id
string	$mode

Protected Attributes
int	$inst
ilXmlWriter	$xml
string	$filename
string	$subdir
string	$export_dir
string	$lang

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

Databay AG ay@da.nosp@m.taba.nosp@m.y.de

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

Constructor & Destructor Documentation

__construct()

ilContObjectExport::__construct	(	ilObjLearningModule	$a_cont_obj,
		string	$a_mode = "xml",
		string	$a_lang = ""
	)

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

References $DIC, $ilDB, IL_INST_ID, and ILIAS\Repository\int().

      {
        global $DIC;

        $ilDB = $DIC->database();

        $this->cont_obj = $a_cont_obj;

        $this->db = $ilDB;
        $this->mode = $a_mode;
        $this->lang = $a_lang;

        $this->inst_id = (int) IL_INST_ID;

        $date = time();
        switch ($this->mode) {
            case "html":
                if ($this->lang == "") {
                    $this->export_dir = $this->cont_obj->getExportDirectory("html");
                } else {
                    $this->export_dir = $this->cont_obj->getExportDirectory("html_" . $this->lang);
                }
                $this->subdir = $this->cont_obj->getType() . "_" . $this->cont_obj->getId();
                $this->filename = $this->subdir . ".zip";
                break;

            default:
                $this->export_dir = $this->cont_obj->getExportDirectory();
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    $this->cont_obj->getType() . "_" . $this->cont_obj->getId();
                $this->filename = $this->subdir . ".xml";
                break;
        }
    }

Here is the call graph for this function:

Member Function Documentation

buildExportFile()

ilContObjectExport::buildExportFile

(

string

$a_mode = ""

)

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

References buildExportFileHTML(), and buildExportFileXML().

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

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

Here is the call graph for this function:

buildExportFileHTML()

ilContObjectExport::buildExportFileHTML

(

)

Definition at line 181 of file class.ilContObjectExport.php.

Referenced by buildExportFile().

                                         : void
    {
        // create directories
        if ($this->lang == "") {
            $this->cont_obj->createExportDirectory("html");
        } else {
            $this->cont_obj->createExportDirectory("html_" . $this->lang);
        }

        // get html content
        $exp = new \ILIAS\LearningModule\Export\LMHtmlExport(
            $this->cont_obj,
            $this->export_dir,
            $this->subdir,
            "html",
            $this->lang
        );
        $exp->exportHTML(true);
    }

Here is the caller graph for this function:

buildExportFileXML()

ilContObjectExport::buildExportFileXML

(

string

$a_mode = ""

)

build xml export file

Definition at line 98 of file class.ilContObjectExport.php.

References $subdir, ilObjContentObject\isOnlineHelpModule(), ilFileUtils\makeDir(), and ilFileUtils\zip().

Referenced by buildExportFile().

     : string {
        if (in_array($a_mode, array("master", "masternomedia"))) {
            $exp = new ilExport();
            $conf = $exp->getConfig("components/ILIAS/LearningModule");
            $conf->setMasterLanguageOnly(true, ($a_mode == "master"));
            $exp->exportObject($this->cont_obj->getType(), $this->cont_obj->getId(), "5.1.0");
            return "";
        }

        $this->xml = new ilXmlWriter();

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

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

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

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

        // get Log File
        $expDir = $this->cont_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->cont_obj->exportXML(
            $this->xml,
            $this->inst_id,
            $this->export_dir . "/" . $this->subdir,
            $expLog
        );

        // export style
        /*
        if ($this->cont_obj->getStyleSheetId() > 0) {
            $style_obj = new ilObjStyleSheet($this->cont_obj->getStyleSheetId(), false);
            $style_obj->setExportSubDir("style");
            $style_file = $style_obj->export();
            if (is_file($style_file)) {
                copy($style_file, $this->export_dir . "/" . $this->subdir . "/style.zip");
            }
        }*/

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

        // help export (workaround to use ref id here)
        if (ilObjContentObject::isOnlineHelpModule(
            $this->cont_obj->getRefId()
        )) {
            $exp = new ilExport();
            $exp->exportEntity(
                "help",
                $this->cont_obj->getId(),
                "4.3.0",
                "components/ILIAS/Help",
                "OnlineHelp",
                $this->export_dir . "/" . $this->subdir
            );
        }

        // 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()

ilContObjectExport::getInstId

(

)

Definition at line 76 of file class.ilContObjectExport.php.

References $inst_id.

                               : int
    {
        return $this->inst_id;
    }

Field Documentation

$cont_obj

ilObjLearningModule ilContObjectExport::$cont_obj

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

$db

ilDBInterface ilContObjectExport::$db

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

$export_dir

string ilContObjectExport::$export_dir

protected

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

$filename

string ilContObjectExport::$filename

protected

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

$inst

int ilContObjectExport::$inst

protected

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

$inst_id

int ilContObjectExport::$inst_id

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

Referenced by getInstId().

$lang

string ilContObjectExport::$lang

protected

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

$mode

string ilContObjectExport::$mode

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

$subdir

string ilContObjectExport::$subdir

protected

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

Referenced by buildExportFileXML().

$xml

ilXmlWriter ilContObjectExport::$xml

protected

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

---

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

• components/ILIAS/LearningModule/Export/class.ilContObjectExport.php