ILIAS\LearningModule\Export\LMHtmlExport Class Reference

Collaboration diagram for ILIAS\LearningModule\Export\LMHtmlExport:

Public Member Functions
	__construct (\ilObjLearningModule $lm, string $export_dir, string $sub_dir, string $export_format="html", string $lang="")
	exportHTML (bool $zip=true)
	exportHTMLPages ()
	export all pages of learning module to html file More...
	exportPageHTML (int $lm_page_id, bool $is_first=false, string $lang="-", string $frame="", array $exp_id_map=[])
	export single page to file More...

Protected Member Functions
	getLinker ()
	setAdditionalContextData (string $key, $data)
	resetUserLanguage ()
	initLanguage (\ilObjUser $user, \ilLMPresentationGUI $lm_gui, string $lang)
	initGlobalScreen ()
	addSupplyingExportFiles ()
	Add supplying export files. More...
	getSupplyingExportFiles (string $a_target_dir=".")
	getInitialisedTemplate ()
	initScreen (int $lm_page_id, string $frame)
	Init global screen and learning module presentation gui for page. More...

Protected Attributes
ExportCollector	$collector
Util	$export_util
ilLogger	$log
string	$target_dir = ""
string	$sub_dir = ""
string	$export_dir = ""
ilObjLearningModule	$lm
ilGlobalTemplateInterface	$main_tpl
ilObjUser	$user
ilLocatorGUI	$locator
ilCOPageHTMLExport	$co_page_html_export
string	$export_format = ""
ilLMPresentationGUI	$lm_gui
Translations	$obj_transl
string	$lang = ""
ilSetting	$lm_settings
array	$offline_files = []
string	$initial_user_language = ""
string	$initial_current_user_language = ""
ILIAS GlobalScreen Services	$global_screen
ILIAS Style Content Object ObjectFacade	$content_style_domain

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ILIAS\LearningModule\Export\LMHtmlExport::__construct	(	\ilObjLearningModule	$lm,
		string	$export_dir,
		string	$sub_dir,
		string	$export_format = "html",
		string	$lang = ""
	)

Definition at line 53 of file class.LMHtmlExport.php.

      {
        global $DIC;
 
        $this->locator = $DIC["ilLocator"];
        $this->user = $DIC->user();
        $this->lm = $lm;
        $this->export_dir = $export_dir;
        $this->sub_dir = $sub_dir;
        $this->lang = $lang;
        $this->target_dir = $export_dir . "/" . $sub_dir;
        $cs = $DIC->contentStyle();
        $this->content_style_domain = $cs->domain()->styleForRefId($this->lm->getRefId());
        $this->collector = $DIC->export()->domain()->html()->collector($this->lm->getId());
        $this->collector->init();
        $this->export_util = new Util("", "", $this->collector);
        $this->co_page_html_export = new \ilCOPageHTMLExport($this->target_dir, $this->getLinker(), $lm->getRefId(), $this->collector);
 
        $this->co_page_html_export->setContentStyleId(
            $this->content_style_domain->getEffectiveStyleId()
        );
        $this->export_format = $export_format;
 
        // get learning module presentation gui class
        $this->lm_gui = new \ilLMPresentationGUI($export_format, ($lang == "all"), $this->target_dir, false);
        $this->obj_transl = $lm->getObjectProperties()->getPropertyTranslations();
 
        $this->lm_settings = new \ilSetting("lm");
 
        $this->log = \ilLoggerFactory::getLogger("lm");
 
        $this->initial_user_language = $this->user->getLanguage();
        $this->initial_current_user_language = $this->user->getCurrentLanguage();
 
        $this->global_screen = $DIC->globalScreen();
 
        $this->setAdditionalContextData(\ilLMEditGSToolProvider::SHOW_TREE, false);
    }

References $DIC, ILIAS\LearningModule\Export\LMHtmlExport\$export_dir, ILIAS\LearningModule\Export\LMHtmlExport\$export_format, ILIAS\LearningModule\Export\LMHtmlExport\$lang, ILIAS\LearningModule\Export\LMHtmlExport\$lm, ILIAS\LearningModule\Export\LMHtmlExport\$sub_dir, ILIAS\LearningModule\Export\LMHtmlExport\getLinker(), ilLoggerFactory\getLogger(), ilObject\getObjectProperties(), ilObject\getRefId(), ILIAS\Repository\locator(), ILIAS\LearningModule\Export\LMHtmlExport\setAdditionalContextData(), ilLMEditGSToolProvider\SHOW_TREE, and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

addSupplyingExportFiles()

ILIAS\LearningModule\Export\LMHtmlExport::addSupplyingExportFiles ( )

protected

Add supplying export files.

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

                                                : void
    {
        foreach ($this->getSupplyingExportFiles() as $f) {
            if ($f["source"] != "") {
                if ($f["type"] == "js") {
                    $this->global_screen->layout()->meta()->addJs($f["source"]);
                }
                if ($f["type"] == "css") {
                    $this->global_screen->layout()->meta()->addCss($f["source"]);
                }
            }
        }
    }

References Vendor\Package\$f.

exportHTML()

ILIAS\LearningModule\Export\LMHtmlExport::exportHTML

(

bool

$zip = true

)

Parameters

bool

$zip

perform a zip at the end

Definition at line 218 of file class.LMHtmlExport.php.

                                                : void
    {
        $this->initGlobalScreen();
 
        $this->export_util->exportSystemStyle(
            [
                "icon_lm.svg"
            ]
        );
        $this->export_util->exportCOPageFiles($this->content_style_domain->getEffectiveStyleId(), "lm");
 
        $lang_iterator = $this->getLanguageIterator();
 
        // iterate all languages
        foreach ($lang_iterator as $lang) {
            $this->initLanguage($this->user, $this->lm_gui, $lang);
            $this->exportHTMLPages();
        }
 
        $this->resetUserLanguage();
 
        $this->addSupplyingExportFiles();
 
        $this->export_util->exportResourceFiles();
 
        $this->co_page_html_export->exportPageElements();
 
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

exportHTMLPages()

ILIAS\LearningModule\Export\LMHtmlExport::exportHTMLPages

(

)

export all pages of learning module to html file

Definition at line 355 of file class.LMHtmlExport.php.

                                     : void
    {
        $lm = $this->lm;
        $lm_gui = $this->lm_gui;
        $lang = $lm_gui->lang;
        $all_languages = ($this->lang == "all");
        $lm_set = $this->lm_settings;
        $ilLocator = $this->locator;
 
        $pages = \ilLMPageObject::getPageList($lm->getId());
 
        $lm_tree = $lm->getLMTree();
        $first_page = $lm_tree->fetchSuccessorNode($lm_tree->getRootId(), "pg");
        $first_page_id = $first_page["child"];
 
        // iterate all learning module pages
        $mobs = [];
        $int_links = [];
        $this->offline_files = [];
 
        // get html export id mapping
 
        $exp_id_map = array();
 
        if ($lm_set->get("html_export_ids")) {
            foreach ($pages as $page) {
                $exp_id = \ilLMPageObject::getExportId($this->lm->getId(), $page["obj_id"]);
                if (trim($exp_id) != "") {
                    $exp_id_map[$page["obj_id"]] = trim($exp_id);
                }
            }
        }
 
        if ($lang == "") {
            $lang = "-";
        }
 
        reset($pages);
        foreach ($pages as $page) {
            if (\ilLMPage::_exists($this->lm->getType(), $page["obj_id"])) {
                $ilLocator->clearItems();
                $this->exportPageHTML($page["obj_id"], ($first_page_id == $page["obj_id"]), $lang, "", $exp_id_map);
                $this->co_page_html_export->collectPageElements("lm:pg", $page["obj_id"], $lang);
            }
        }
    }

References $lm_set, ilPageObject\_exists(), ilLMObject\getExportId(), and ilLMPageObject\getPageList().

Here is the call graph for this function:

exportPageHTML()

ILIAS\LearningModule\Export\LMHtmlExport::exportPageHTML	(	int	$lm_page_id,
		bool	$is_first = false,
		string	$lang = "-",
		string	$frame = "",
		array	$exp_id_map = []
	)

export single page to file

Definition at line 455 of file class.LMHtmlExport.php.

     : void {
        $target_dir = $this->target_dir;
        $lang_suffix = "";
        if (!in_array($lang, ["-", ""]) && $this->lang === "all") {
            $lang_suffix = "_" . $lang;
        }
 
        // Init template, lm_gui
        $this->initScreen($lm_page_id, $frame);
 
        if ($frame == "") {
            if (is_array($exp_id_map) && isset($a_exp_id_map[$lm_page_id])) {
                $file = "lm_pg_" . $exp_id_map[$lm_page_id] . $lang_suffix . ".html";
            } else {
                $file = "lm_pg_" . $lm_page_id . $lang_suffix . ".html";
            }
        } else {
            if ($frame != "toc") {
                $file = "frame_" . $lm_page_id . "_" . $frame . $lang_suffix . ".html";
            } else {
                $file = "frame_" . $frame . $lang_suffix . ".html";
            }
        }
 
        // return if file is already existing
        /*
        if (is_file($file)) {
            return;
        }*/
 
        $content = $this->lm_gui->layout("main.xml", false);
 
        $this->collector->addString($content, $file);
 
        if ($is_first && $frame == "") {
            $this->collector->addString($content, "index" . $lang_suffix . ".html");
        }
    }

getInitialisedTemplate()

ILIAS\LearningModule\Export\LMHtmlExport::getInitialisedTemplate ( )

protected

Definition at line 402 of file class.LMHtmlExport.php.

                                               : \ilGlobalPageTemplate
    {
        global $DIC;
 
        $tabs = $DIC->tabs();
 
        $tabs->clearTargets();
        $tabs->clearSubTabs();
        $tpl = new \ilGlobalPageTemplate($DIC->globalScreen(), $DIC->ui(), $DIC->http());
 
        $this->co_page_html_export->getPreparedMainTemplate($tpl);
 
        return $tpl;
    }

References $DIC.

getLinker()

ILIAS\LearningModule\Export\LMHtmlExport::getLinker ( )

protected

Definition at line 97 of file class.LMHtmlExport.php.

                                  : PageLinker
    {
        return new \ilLMPresentationLinker(
            $this->lm,
            new \ilLMTree($this->lm->getId()),
            0,
            $this->lm->getRefId(),
            $this->lang,
            "",
            "",
            true,
            "html",
            false
        );
    }

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct().

Here is the caller graph for this function:

getSupplyingExportFiles()

ILIAS\LearningModule\Export\LMHtmlExport::getSupplyingExportFiles ( string  $a_target_dir = "." )

protected

Todo:

modularize!

Definition at line 268 of file class.LMHtmlExport.php.

                                                                          : array
    {
        $scripts = array(
            array("source" => './components/ILIAS/Accordion/js/accordion.js',
                "target" => $a_target_dir . '/js/accordion.js',
                "type" => "js"),
            array("source" => './components/ILIAS/Accordion/css/accordion.css',
                "target" => $a_target_dir . '/css/accordion.css',
                "type" => "css"),
            array("source" => './components/ILIAS/TestQuestionPool/resources/js/dist/pure_rendering.js',
                "target" => $a_target_dir . '/js/pure.js',
                "type" => "js"),
            array("source" => './components/ILIAS/TestQuestionPool/resources/js/dist/question_handling.js',
                "target" => $a_target_dir . '/js/question_handling.js',
                "type" => "js"),
            array("source" => './components/ILIAS/TestQuestionPool/resources/js/dist/question_handling.css',
                "target" => $a_target_dir . '/css/question_handling.css',
                "type" => "css"),
            array("source" => './components/ILIAS/TestQuestionPool/templates/default/test_javascript.css',
                "target" => $a_target_dir . '/css/test_javascript.css',
                "type" => "css"),
            array("source" => \ilExplorerBaseGUI::getLocalExplorerJsPath(),
                "target" => $a_target_dir . "/" . \ilExplorerBaseGUI::getLocalExplorerJsPath(),
                "type" => "js"),
            array("source" => \ilExplorerBaseGUI::getLocalJsTreeJsPath(),
                "target" => $a_target_dir . "/" . \ilExplorerBaseGUI::getLocalJsTreeJsPath(),
                "type" => "js"),
            array("source" => \ilExplorerBaseGUI::getLocalJsTreeCssPath(),
                "target" => $a_target_dir . "/" . \ilExplorerBaseGUI::getLocalJsTreeCssPath(),
                "type" => "css"),
            array("source" => './components/ILIAS/LearningModule/js/LearningModule.js',
                "target" => $a_target_dir . '/js/LearningModule.js',
                "type" => "js")
        );
 
        $mathJaxSetting = new \ilSetting("MathJax");
        $use_mathjax = (bool) $mathJaxSetting->get("enable");
        if ($use_mathjax) {
            $scripts[] = array("source" => "",
                "target" => $mathJaxSetting->get("path_to_mathjax"),
                "type" => "js");
        }
 
        // auto linking js
        foreach (\ilLinkifyUtil::getLocalJsPaths() as $p) {
            if (is_int(strpos($p, "ExtLink"))) {
                $scripts[] = array("source" => $p,
                    "target" => $a_target_dir . '/js/ilExtLink.js',
                    "type" => "js");
            }
            if (is_int(strpos($p, "linkify"))) {
                $scripts[] = array("source" => $p,
                    "target" => $a_target_dir . '/js/linkify.js',
                    "type" => "js");
            }
        }
 
        // check, why these do not come with the gs meta collector
        $scripts[] = [
            "source" => "assets/js/mainbar.js",
            "type" => "js"
        ];
        $scripts[] = [
            "source" => "assets/js/metabar.js",
            "type" => "js"
        ];
        $scripts[] = [
            "source" => "assets/js/slate.js",
            "type" => "js"
        ];
        $scripts[] = [
            "source" => "assets/js/stdpage.js",
            "type" => "js"
        ];
        $scripts[] = [
            "source" => "assets/js/GS.js",
            "type" => "js"
        ];
 
        return $scripts;
    }

References ilExplorerBaseGUI\getLocalExplorerJsPath(), ilLinkifyUtil\getLocalJsPaths(), ilExplorerBaseGUI\getLocalJsTreeCssPath(), and ilExplorerBaseGUI\getLocalJsTreeJsPath().

Here is the call graph for this function:

initGlobalScreen()

ILIAS\LearningModule\Export\LMHtmlExport::initGlobalScreen ( )

protected

Definition at line 205 of file class.LMHtmlExport.php.

                                         : void
    {
        // set global
        $this->global_screen->tool()->context()->current()->addAdditionalData(
            \ilLMHtmlExportViewLayoutProvider::LM_HTML_EXPORT_RENDERING,
            true
        );
    }

References ilLMHtmlExportViewLayoutProvider\LM_HTML_EXPORT_RENDERING.

initLanguage()

ILIAS\LearningModule\Export\LMHtmlExport::initLanguage ( \ilObjUser  $user, \ilLMPresentationGUI  $lm_gui, string  $lang  )

protected

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

     : void {
        $user_lang = $user->getLanguage();
 
        if ($lang != "") {
            $user->setLanguage($lang);
            $user->setCurrentLanguage($lang);
        } else {
            $user->setLanguage($user_lang);
            $user->setCurrentLanguage($user_lang);
        }
 
        if ($lang != "") {
            if ($lang == $this->obj_transl->getBaseLanguage()) {
                $lm_gui->lang = "";
            } else {
                $lm_gui->lang = $lang;
            }
        }
    }

References ILIAS\LearningModule\Export\LMHtmlExport\$lang, ILIAS\LearningModule\Export\LMHtmlExport\$user, ilObjUser\setCurrentLanguage(), and ilObjUser\setLanguage().

Here is the call graph for this function:

initScreen()

ILIAS\LearningModule\Export\LMHtmlExport::initScreen ( int  $lm_page_id, string  $frame  )

protected

Init global screen and learning module presentation gui for page.

Definition at line 421 of file class.LMHtmlExport.php.

     : void {
        $this->global_screen->layout()->meta()->reset();
 
        // load style sheet depending on user's settings
        $location_stylesheet = \ilUtil::getStyleSheetLocation();
        $this->global_screen->layout()->meta()->addCss($location_stylesheet);
 
        $this->addSupplyingExportFiles();
 
        // template workaround: reset of template
        $tpl = $this->getInitialisedTemplate();
        \ilPCQuestion::resetInitialState();
 
        $params = [
            "obj_id" => $lm_page_id,
            "ref_id" => $this->lm->getRefId(),
            "frame" => $frame
        ];
 
        $this->lm_gui->initByRequest($params);
 
        $this->setAdditionalContextData(\ilLMGSToolProvider::LM_QUERY_PARAMS, $params);
        $this->setAdditionalContextData(\ilLMGSToolProvider::LM_OFFLINE, true);
 
        $this->lm_gui->injectTemplate($tpl);
    }

resetUserLanguage()

ILIAS\LearningModule\Export\LMHtmlExport::resetUserLanguage ( )

protected

Definition at line 126 of file class.LMHtmlExport.php.

                                          : void
    {
        $this->user->setLanguage($this->initial_user_language);
        $this->user->setCurrentLanguage($this->initial_current_user_language);
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

setAdditionalContextData()

ILIAS\LearningModule\Export\LMHtmlExport::setAdditionalContextData ( string  $key,   $data  )

protected

Parameters

mixed

$data

Definition at line 116 of file class.LMHtmlExport.php.

                                                                   : void
    {
        $additional_data = $this->global_screen->tool()->context()->current()->getAdditionalData();
        if ($additional_data->exists($key)) {
            $additional_data->replace($key, $data);
        } else {
            $additional_data->add($key, $data);
        }
    }

References $data.

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct().

Here is the caller graph for this function:

Field Documentation

$co_page_html_export

ilCOPageHTMLExport ILIAS\LearningModule\Export\LMHtmlExport::$co_page_html_export

protected

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

$collector

ExportCollector ILIAS\LearningModule\Export\LMHtmlExport::$collector

protected

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

$content_style_domain

ILIAS Style Content Object ObjectFacade ILIAS\LearningModule\Export\LMHtmlExport::$content_style_domain

protected

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

$export_dir

string ILIAS\LearningModule\Export\LMHtmlExport::$export_dir = ""

protected

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

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct().

$export_format

string ILIAS\LearningModule\Export\LMHtmlExport::$export_format = ""

protected

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

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct().

$export_util

Util ILIAS\LearningModule\Export\LMHtmlExport::$export_util

protected

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

$global_screen

ILIAS GlobalScreen Services ILIAS\LearningModule\Export\LMHtmlExport::$global_screen

protected

Definition at line 50 of file class.LMHtmlExport.php.

$initial_current_user_language

string ILIAS\LearningModule\Export\LMHtmlExport::$initial_current_user_language = ""

protected

Definition at line 49 of file class.LMHtmlExport.php.

$initial_user_language

string ILIAS\LearningModule\Export\LMHtmlExport::$initial_user_language = ""

protected

Definition at line 48 of file class.LMHtmlExport.php.

$lang

string ILIAS\LearningModule\Export\LMHtmlExport::$lang = ""

protected

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

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct(), and ILIAS\LearningModule\Export\LMHtmlExport\initLanguage().

$lm

ilObjLearningModule ILIAS\LearningModule\Export\LMHtmlExport::$lm

protected

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

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct().

$lm_gui

ilLMPresentationGUI ILIAS\LearningModule\Export\LMHtmlExport::$lm_gui

protected

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

$lm_settings

ilSetting ILIAS\LearningModule\Export\LMHtmlExport::$lm_settings

protected

Definition at line 46 of file class.LMHtmlExport.php.

$locator

ilLocatorGUI ILIAS\LearningModule\Export\LMHtmlExport::$locator

protected

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

$log

ilLogger ILIAS\LearningModule\Export\LMHtmlExport::$log

protected

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

$main_tpl

ilGlobalTemplateInterface ILIAS\LearningModule\Export\LMHtmlExport::$main_tpl

protected

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

$obj_transl

Translations ILIAS\LearningModule\Export\LMHtmlExport::$obj_transl

protected

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

$offline_files

array ILIAS\LearningModule\Export\LMHtmlExport::$offline_files = []

protected

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

$sub_dir

string ILIAS\LearningModule\Export\LMHtmlExport::$sub_dir = ""

protected

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

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\__construct().

$target_dir

string ILIAS\LearningModule\Export\LMHtmlExport::$target_dir = ""

protected

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

$user

ilObjUser ILIAS\LearningModule\Export\LMHtmlExport::$user

protected

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

Referenced by ILIAS\LearningModule\Export\LMHtmlExport\initLanguage().

---

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

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