ilCOPageHTMLExport Class Reference

HTML export class for pages. More...

Collaboration diagram for ilCOPageHTMLExport:

Public Member Functions
	__construct (string $a_exp_dir, \ILIAS\COPage\PageLinker $linker=null, int $ref_id=0, protected ?ExportCollector $export_collector=null)
	setContentStyleId (int $a_val)
	getContentStyleId ()
	createDirectories ()
	exportStyles ()
	Export content style. More...
	exportSupportScripts ()
	Export support scripts. More...
	getPreparedMainTemplate (ilGlobalTemplateInterface $a_tpl=null)
	collectPageElements (string $a_type, int $a_id, string $lang="")
	Collect page elements (that need to be exported separately) More...
	exportPageElements (callable $a_update_callback=null)
	Export page elements. More...
	exportHTMLMOB (int $a_mob_id, array &$a_linked_mobs)
	Export media object to html. More...
	exportHTMLFile (string $a_file_id)
	Export file object. More...
	exportHTMLFileDirect (string $a_file_id, string $a_source_file, string $a_file_name)
	Export file from path. More...
	exportHTMLGlossaryTerms ()

Protected Member Functions
	exportResourceFile (string $target_dir, string $file)
	initResourceTemplate (string $template_file)
	Get resource template. More...
	renderMob (\ilObjMediaObject $mob_obj, string $link_xml, array $params)
	Render Mob. More...
	exportQuestionFiles ()
	Export question images. More...

Protected Attributes
ILIAS MediaObjects MediaObjectManager	$media_manager
ILIAS Style Content InternalDomainService	$content_style
ILIAS COPage Xsl XslManager	$xsl
string	$css_dir = ""
string	$js_yahoo_dir = ""
string	$js_dir = ""
string	$media_service_dir = ""
string	$services_dir = ""
string	$content_style_img_dir = ""
string	$content_style_dir = ""
string	$tex_dir = ""
string	$files_dir = ""
string	$mobs_dir = ""
array	$mobs = []
array	$glossary_terms = []
array	$files = []
array	$files_direct = []
array	$int_links = []
array	$q_ids = []
string	$exp_dir = ""
int	$content_style_id = 0
ilObjUser	$user
ilLogger	$log
ILIAS GlobalScreen Services	$global_screen
ILIAS Skill Service SkillTreeService	$skill_tree_service
ILIAS Skill Service SkillPersonalService	$skill_personal_service
ILIAS COPage PageLinker	$page_linker
int	$ref_id

Detailed Description

HTML export class for pages.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCOPageHTMLExport::__construct	(	string	$a_exp_dir,
		\ILIAS\COPage\PageLinker	$linker = null,
		int	$ref_id = 0,
		protected ?ExportCollector	$export_collector = null
	)

Definition at line 57 of file class.ilCOPageHTMLExport.php.

References $DIC, $ref_id, ilLoggerFactory\getLogger(), and ILIAS\Repository\user().

      {
        global $DIC;
        $this->log = ilLoggerFactory::getLogger('copg');
        $this->user = $DIC->user();
        $this->global_screen = $DIC->globalScreen();
        $this->skill_tree_service = $DIC->skills()->tree();
        $this->skill_personal_service = $DIC->skills()->personal();
        $this->page_linker = is_null($linker)
            ? new ilPageLinker("", true)
            : $linker;
        $this->ref_id = $ref_id;

        $this->exp_dir = $a_exp_dir;
        $this->mobs_dir = $a_exp_dir . "/mobs";
        $this->files_dir = $a_exp_dir . "/files";
        $this->tex_dir = $a_exp_dir . "/teximg";
        $this->content_style_dir = $a_exp_dir . "/content_style";
        $this->content_style_img_dir = $a_exp_dir . "/content_style/images";

        $this->services_dir = $a_exp_dir . "/components/ILIAS";
        $this->media_service_dir = $this->services_dir . "/MediaObjects";

        $this->js_dir = $a_exp_dir . '/js';
        $this->js_yahoo_dir = $a_exp_dir . '/js/yahoo';
        $this->css_dir = $a_exp_dir . '/css';
        $this->xsl = $DIC->copage()->internal()->domain()->xsl();
        $this->content_style = $DIC->contentStyle()->internal()->domain();
        $this->media_manager = $DIC->mediaObjects()->internal()->domain()->mediaObject();
    }

Here is the call graph for this function:

Member Function Documentation

collectPageElements()

ilCOPageHTMLExport::collectPageElements	(	string	$a_type,
		int	$a_id,
		string	$lang = ""
	)

Collect page elements (that need to be exported separately)

Definition at line 259 of file class.ilCOPageHTMLExport.php.

References Vendor\Package\$f, $user_id, ilObjMediaObject\_getMobsOfObject(), ilPCQuestion\_getQuestionIdsForPage(), ilInternalLink\_getTargetsOfSource(), ilSkillTemplateReference\_lookupTemplateId(), ilObject\_lookupTitle(), ilSkillTreeNode\_lookupType(), ilObject\_lookupType(), ilSkillTreeNodeFactory\getInstance(), ilPageContentUsage\getUsagesOfPage(), and ILIAS\Repository\int().

Referenced by ILIAS\Wiki\Export\BlogHtmlExport\collectAllPagesPageElements().

     : void {
        $this->log->debug("collect page elements");

        // collect all dependent pages (only one level deep)
        $pages[] = [
            "type" => $a_type,
            "id" => $a_id
        ];

        // ... content includes
        $pcs = ilPageContentUsage::getUsagesOfPage($a_id, $a_type, 0, false, $lang);
        foreach ($pcs as $pc) {
            // content includes
            if ($pc["type"] == "incl") {
                $pages[] = [
                    "type" => "mep:pg",
                    "id" => $pc["id"]
                ];
            }
        }

        // ... internal links
        $pg_links = \ilInternalLink::_getTargetsOfSource($a_type, $a_id, $lang);
        $this->int_links = array_merge($this->int_links, $pg_links);
        $this->glossary_terms = [];

        // ... glossary pages of internal links
        foreach ($this->int_links as $int_link) {
            if ($int_link["type"] == "git") {
                $this->glossary_terms[] = $int_link["id"];
                // store linked/embedded media objects of glosssary term
                $pages[] = [
                    "type" => "term:pg",
                    "id" => $int_link["id"]
                ];
            }
        }

        // resources of pages
        foreach ($pages as $page) {
            $page_id = $page["id"];
            $page_type = $page["type"];

            // collect media objects
            $pg_mobs = ilObjMediaObject::_getMobsOfObject($page_type, $page_id, 0, $lang);
            foreach ($pg_mobs as $pg_mob) {
                $this->mobs[$pg_mob] = $pg_mob;
                $this->log->debug("HTML Export: Add media object $pg_mob (" . \ilObject::_lookupTitle($pg_mob) . ") " .
                    " due to page $page_id, $page_type ).");
            }

            // collect all files
            $files = ilObjFile::_getFilesOfObject($page_type, $page_id, 0, $lang);
            foreach ($files as $f) {
                $this->files[$f] = $f;
            }

            // collect all questions
            $q_ids = \ilPCQuestion::_getQuestionIdsForPage($a_type, $a_id, $lang);
            foreach ($q_ids as $q_id) {
                $this->q_ids[$q_id] = $q_id;
            }
        }

        // collect page content items
        $skill_tree = $ws_tree = null;

        // skills
        foreach ($pcs as $pc) {
            if ($pc["type"] == "skmg") {
                $skill_id = $pc["id"];

                // trying to find user id
                $user_id = null;
                switch ($a_type) {
                    case "prtf:pg":
                        $page = new ilPortfolioPage($a_id);
                        $user_id = $page->getCreationUserId();
                        break;

                    default:
                        // :TODO:
                        break;
                }

                if ($user_id) {
                    // we only need 1 instance each
                    if (!$skill_tree) {
                        $skill_tree = $this->skill_tree_service->getGlobalSkillTree();

                        $ws_tree = new ilWorkspaceTree($user_id);
                    }

                    // walk skill tree
                    $skill_id = (int) $skill_id;
                    $vtree = $this->skill_tree_service->getVirtualSkillTreeForNodeId($skill_id);
                    $tref_id = 0;
                    if (ilSkillTreeNode::_lookupType($skill_id) == "sktr") {
                        $tref_id = $skill_id;
                        $skill_id = ilSkillTemplateReference::_lookupTemplateId($skill_id);
                    }
                    $b_skills = $vtree->getSubTreeForCSkillId($skill_id . ":" . $tref_id, true);

                    foreach ($b_skills as $bs) {
                        $skill = ilSkillTreeNodeFactory::getInstance($bs["skill_id"]);
                        $level_data = $skill->getLevelData();
                        foreach ($level_data as $k => $v) {
                            // get assigned materials from personal skill
                            $mat = $this->skill_personal_service->getAssignedMaterials($user_id, $bs["tref_id"], $v["id"]);
                            if (count($mat)) {
                                foreach ($mat as $item) {
                                    $wsp_id = $item->getWorkspaceId();
                                    $obj_id = $ws_tree->lookupObjectId($wsp_id);

                                    // all possible material types for now
                                    switch (ilObject::_lookupType($obj_id)) {
                                        case "file":
                                            $this->files[$obj_id] = $obj_id;
                                            break;

                                        case "tstv":
                                            $obj = new ilObjTestVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "excv":
                                            $obj = new ilObjExerciseVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "crsv":
                                            $obj = new ilObjCourseVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "cmxv":
                                            $obj = new ilObjCmiXapiVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "ltiv":
                                            $obj = new ilObjLTIConsumerVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;

                                        case "scov":
                                            $obj = new ilObjSCORMVerification($obj_id, false);
                                            $this->files_direct[$obj_id] = array($obj->getFilePath(),
                                                                                 $obj->getOfflineFilename());
                                            break;
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createDirectories()

ilCOPageHTMLExport::createDirectories

(

)

Definition at line 102 of file class.ilCOPageHTMLExport.php.

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

                                       : void
    {
        ilFileUtils::makeDir($this->mobs_dir);
        ilFileUtils::makeDir($this->files_dir);
        ilFileUtils::makeDir($this->tex_dir);
        ilFileUtils::makeDir($this->content_style_dir);
        ilFileUtils::makeDir($this->content_style_img_dir);
        ilFileUtils::makeDir($this->services_dir);
        ilFileUtils::makeDir($this->media_service_dir);

        ilFileUtils::makeDirParents($this->js_dir);
        ilFileUtils::makeDirParents($this->js_yahoo_dir);
        ilFileUtils::makeDirParents($this->css_dir);
        ilFileUtils::makeDirParents($this->css_dir . "/yahoo");
    }

Here is the call graph for this function:

exportHTMLFile()

ilCOPageHTMLExport::exportHTMLFile

(

string

$a_file_id

)

Export file object.

Definition at line 591 of file class.ilCOPageHTMLExport.php.

References ilFileUtils\makeDir().

Referenced by exportPageElements().

                                                     : void
    {
        $file_dir = $this->files_dir . "/file_" . $a_file_id;
        ilFileUtils::makeDir($file_dir);

        $file_obj = new ilObjFile($a_file_id, false);
        $source_file = $file_obj->getFile($file_obj->getVersion());
        if (!is_file($source_file)) {
            $source_file = $file_obj->getFile();
        }
        if (is_file($source_file)) {
            copy($source_file, $file_dir . "/" . $file_obj->getFileName());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportHTMLFileDirect()

ilCOPageHTMLExport::exportHTMLFileDirect	(	string	$a_file_id,
		string	$a_source_file,
		string	$a_file_name
	)

Export file from path.

Definition at line 609 of file class.ilCOPageHTMLExport.php.

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

Referenced by exportPageElements().

     : void {
        $file_dir = $this->files_dir . "/file_" . $a_file_id;
        ilFileUtils::makeDir($file_dir);

        if (is_file($a_source_file)) {
            copy(
                $a_source_file,
                $file_dir . "/" . ilFileUtils::getASCIIFilename($a_file_name)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportHTMLGlossaryTerms()

ilCOPageHTMLExport::exportHTMLGlossaryTerms

(

)

Definition at line 642 of file class.ilCOPageHTMLExport.php.

References ilGlossaryTerm\_exists(), and initResourceTemplate().

Referenced by exportPageElements().

                                             : void
    {
        foreach ($this->glossary_terms as $term_id) {
            if (!ilGlossaryTerm::_exists($term_id)) {
                continue;
            }
            $tpl = $this->initResourceTemplate("tpl.glossary_term_output.html");

            $term_gui = new ilGlossaryTermGUI($term_id);
            $term_gui->setPageLinker($this->page_linker);
            $term_gui->setOfflineDirectory($this->exp_dir);
            $term_gui->output(true, $tpl);

            // write file
            $html = $tpl->printToString();
            $file = $this->exp_dir . "/term_" . $term_id . ".html";
            $fp = fopen($file, "w+");
            fwrite($fp, $html);
            fclose($fp);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportHTMLMOB()

ilCOPageHTMLExport::exportHTMLMOB	(	int	$a_mob_id,
		array &	$a_linked_mobs
	)

Export media object to html.

Definition at line 498 of file class.ilCOPageHTMLExport.php.

References $params, $ref_id, ilMediaItem\_getMapAreasIntLinks(), ilUtil\getImagePath(), ilFileUtils\getWebspaceDir(), initResourceTemplate(), ilObjMediaObject\isTypeAllowed(), ilFileUtils\makeDir(), ilFileUtils\rCopy(), and renderMob().

Referenced by exportPageElements().

     : void {
        $this->log->debug("export html mobs");

        if (is_null($this->export_collector)) {
            $source_dir = ilFileUtils::getWebspaceDir() . "/mobs/mm_" . $a_mob_id;
            if (is_dir($source_dir)) {
                ilFileUtils::makeDir($this->mobs_dir . "/mm_" . $a_mob_id);
                ilFileUtils::rCopy($source_dir, $this->mobs_dir . "/mm_" . $a_mob_id);
            }
        } else {
            $mob_res_id = $this->media_manager->getContainerResourceId($a_mob_id);
            if ($mob_res_id) {
                $this->export_collector->addContainerDirectory(
                    $mob_res_id->serialize(),
                    "",
                    "/mobs/mm_" . $a_mob_id,
                );
            }
        }

        $mob_obj = new ilObjMediaObject($a_mob_id);

        $tpl = $this->initResourceTemplate("tpl.fullscreen.html");
        $med_links = ilMediaItem::_getMapAreasIntLinks($a_mob_id);
        $link_xml = $this->page_linker->getLinkXML($med_links);

        $params = [
            "mode" => "media",
            'enlarge_path' => ilUtil::getImagePath("media/enlarge.svg", false, "output", true),
            'enable_html_mob' => ilObjMediaObject::isTypeAllowed("html") ? "y" : "n",
            'fullscreen_link' => $this->page_linker->getFullScreenLink()
        ];
        if ($this->ref_id > 0) {
            $params["ref_id"] = $this->ref_id;
            $params["link_params"] = "ref_id=" . $this->ref_id;
        }

        $tpl->setVariable("MEDIA_CONTENT", $this->renderMob($mob_obj, $link_xml, $params));
        $html = $tpl->printToString();
        if (is_null($this->export_collector)) {
            $file = $this->exp_dir . "/media_" . $a_mob_id . ".html";
            $fp = fopen($file, "w+");
            fwrite($fp, $html);
            fclose($fp);
            unset($fp);
        } else {
            $this->export_collector->addString($html, "/media_" . $a_mob_id . ".html");
        }

        if ($mob_obj->hasFullscreenItem()) {
            $tpl = $this->initResourceTemplate("tpl.fullscreen.html");
            $params["mode"] = "fullscreen";
            $tpl->setVariable("MEDIA_CONTENT", $this->renderMob($mob_obj, $link_xml, $params));
            $html = $tpl->printToString();
            if (is_null($this->export_collector)) {
                $file = $this->exp_dir . "/fullscreen_" . $a_mob_id . ".html";
                $fp = fopen($file, "w+");
                fwrite($fp, $html);
                fclose($fp);
                unset($fp);
            } else {
                $this->export_collector->addString($html, "/fullscreen_" . $a_mob_id . ".html");
            }
        }

        $linked_mobs = $mob_obj->getLinkedMediaObjects();
        $a_linked_mobs = array_merge($a_linked_mobs, $linked_mobs);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportPageElements()

ilCOPageHTMLExport::exportPageElements

(

callable

$a_update_callback = null

)

Export page elements.

Definition at line 431 of file class.ilCOPageHTMLExport.php.

References ilObject\_exists(), ilObject\_lookupType(), exportHTMLFile(), exportHTMLFileDirect(), exportHTMLGlossaryTerms(), exportHTMLMOB(), and exportQuestionFiles().

     : void {
        $this->log->debug("export page elements");

        $total = count($this->mobs) + count($this->files) + count($this->files_direct);
        $cnt = 0;
        // export all media objects
        $linked_mobs = array();
        foreach ($this->mobs as $mob) {
            if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob") {
                $this->exportHTMLMOB($mob, $linked_mobs);
            }
            if (is_callable($a_update_callback)) {
                $cnt++;
                $a_update_callback($total, $cnt);
            }
        }
        $linked_mobs2 = array();                                // mobs linked in link areas
        foreach ($linked_mobs as $mob) {
            if (ilObject::_exists($mob)) {
                $this->exportHTMLMOB($mob, $linked_mobs2);
            }
        }

        // export all file objects
        foreach ($this->files as $file) {
            $this->exportHTMLFile($file);
            if (is_callable($a_update_callback)) {
                $cnt++;
                $a_update_callback($total, $cnt);
            }
        }

        // export all files (which are not objects
        foreach ($this->files_direct as $file_id => $attr) {
            $this->exportHTMLFileDirect($file_id, $attr[0], $attr[1]);
            if (is_callable($a_update_callback)) {
                $cnt++;
                $a_update_callback($total, $cnt);
            }
        }

        $this->exportQuestionFiles();

        // export all glossary terms
        $this->exportHTMLGlossaryTerms();
    }

Here is the call graph for this function:

exportQuestionFiles()

ilCOPageHTMLExport::exportQuestionFiles ( )

protected

Export question images.

Definition at line 628 of file class.ilCOPageHTMLExport.php.

References ilFileUtils\getWebspaceDir(), ilFileUtils\makeDirParents(), and ilFileUtils\rCopy().

Referenced by exportPageElements().

                                            : void
    {
        // export questions (images)
        if (count($this->q_ids) > 0) {
            foreach ($this->q_ids as $q_id) {
                ilFileUtils::makeDirParents($this->exp_dir . "/assessment/0/" . $q_id . "/images");
                ilFileUtils::rCopy(
                    ilFileUtils::getWebspaceDir() . "/assessment/0/" . $q_id . "/images",
                    $this->exp_dir . "/assessment/0/" . $q_id . "/images"
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportResourceFile()

ilCOPageHTMLExport::exportResourceFile ( string  $target_dir, string  $file  )

protected

Definition at line 197 of file class.ilCOPageHTMLExport.php.

References ilFileUtils\makeDirParents().

Referenced by exportStyles(), and exportSupportScripts().

     : void {
        if (is_int(strpos($file, "?"))) {
            $file = substr($file, 0, strpos($file, "?"));
        }
        if (is_file($file)) {
            if (is_null($this->export_collector)) {
                $dir = dirname($file);
                ilFileUtils::makeDirParents($target_dir . "/" . $dir);
                if (!is_file($target_dir . "/" . $file)) {
                    copy($file, $target_dir . "/" . $file);
                }
            } else {
                $this->export_collector->addFile($file, $file);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportStyles()

ilCOPageHTMLExport::exportStyles

(

)

Export content style.

Exceptions

Definition at line 124 of file class.ilCOPageHTMLExport.php.

References exportResourceFile(), ilObjStyleSheet\getBasicImageDir(), ilObjStyleSheet\getContentPrintStyle(), getContentStyleId(), ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getExportContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ilFileUtils\makeDirParents(), and ilFileUtils\rCopy().

                                  : void
    {
        $this->log->debug("export styles");

        // export content style sheet
        if ($this->getContentStyleId() < 1) {     // basic style
            if (is_null($this->export_collector)) {
                ilFileUtils::rCopy(
                    ilObjStyleSheet::getBasicImageDir(),
                    $this->exp_dir . "/" . ilObjStyleSheet::getBasicImageDir()
                );
                ilFileUtils::makeDirParents($this->exp_dir . "/components/ILIAS/COPage/css");
                copy("../components/ILIAS/COPage/resources/content.css",
                    $this->exp_dir . "/components/ILIAS/COPage/css/content.css");
            } else {
                $this->export_collector->addDirectory(
                    ilObjStyleSheet::getBasicImageDir(),
                    "/basic_style/images"
                );
                $this->export_collector->addFile(
                    "../components/ILIAS/COPage/css/content.css",
                    ilObjStyleSheet::getExportContentStylePath()
                );
            }
        } else {
            $style = new ilObjStyleSheet($this->getContentStyleId());
            if (is_null($this->export_collector)) {
                $style->copyImagesToDir($this->exp_dir . "/" . $style->getImagesDirectory());
                $this->exportResourceFile(
                    $this->exp_dir,
                    ilObjStyleSheet::getContentStylePath($this->getContentStyleId(), false, false)
                );
            } else {
                $res_id = $this->content_style->style($this->getContentStyleId())->getResourceIdentification();
                if ($res_id) {
                    $this->export_collector->addContainerDirectory(
                        $res_id->serialize(),
                        "",
                        "content_style"
                    );
                }
            }
        }

        // export syntax highlighting style
        $syn_stylesheet = ilObjStyleSheet::getSyntaxStylePath();
        $this->exportResourceFile($this->exp_dir, $syn_stylesheet);

        // export print style
        $print_stylesheet = ilObjStyleSheet::getContentPrintStyle();
        $this->exportResourceFile($this->exp_dir, $print_stylesheet);
    }

Here is the call graph for this function:

exportSupportScripts()

ilCOPageHTMLExport::exportSupportScripts

(

)

Export support scripts.

Todo:

: use ilPageContent js/css functions here (problem: currently they need a page object for init)

Definition at line 182 of file class.ilCOPageHTMLExport.php.

References exportResourceFile(), and ilPageObjectGUI\OFFLINE.

                                          : void
    {
        $this->log->debug("export scripts");

        $collector = new \ILIAS\COPage\ResourcesCollector(ilPageObjectGUI::OFFLINE);

        foreach ($collector->getJavascriptFiles() as $js) {
            $this->exportResourceFile($this->exp_dir, $js);
        }

        foreach ($collector->getCssFiles() as $css) {
            $this->exportResourceFile($this->exp_dir, $css);
        }
    }

Here is the call graph for this function:

getContentStyleId()

ilCOPageHTMLExport::getContentStyleId

(

)

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

References $content_style_id.

Referenced by exportStyles(), and initResourceTemplate().

                                       : int
    {
        return $this->content_style_id;
    }

Here is the caller graph for this function:

getPreparedMainTemplate()

ilCOPageHTMLExport::getPreparedMainTemplate

(

ilGlobalTemplateInterface

$a_tpl = null

)

Definition at line 217 of file class.ilCOPageHTMLExport.php.

References $DIC, ilObjStyleSheet\getExportContentStylePath(), ilUtil\getStyleSheetLocation(), ilObjStyleSheet\getSyntaxStylePath(), and ilPageObjectGUI\OFFLINE.

Referenced by initResourceTemplate().

     : ilGlobalTemplateInterface {
        global $DIC;
        $this->log->debug("get main template");


        $resource_collector = new \ILIAS\COPage\ResourcesCollector(ilPageObjectGUI::OFFLINE);
        $resource_injector = new \ILIAS\COPage\ResourcesInjector($resource_collector);

        if (!is_null($a_tpl)) {
            $tpl = $a_tpl;
        } else {
            // template workaround: reset of template
            $tpl = new ilGlobalPageTemplate($DIC->globalScreen(), $DIC->ui(), $DIC->http());
        }

        // scripts needed
        /* @todo check
        $scripts = [];
        $scripts = array_merge($scripts, ilPlayerUtil::getJsFilePaths());

        $mathJaxSetting = new ilSetting("MathJax");
        $use_mathjax = $mathJaxSetting->get("enable");
        if ($use_mathjax) {
            $scripts[] = $mathJaxSetting->get("path_to_mathjax");
        }
        */

        $tpl->addCss(\ilUtil::getStyleSheetLocation());
        // important, we pass 0 here, since the export will use the standard directory
        $tpl->addCss(ilObjStyleSheet::getExportContentStylePath());
        $tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());

        $resource_injector->inject($tpl);

        return $tpl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initResourceTemplate()

ilCOPageHTMLExport::initResourceTemplate ( string  $template_file )

protected

Get resource template.

Definition at line 483 of file class.ilCOPageHTMLExport.php.

References getContentStyleId(), ilObjStyleSheet\getContentStylePath(), getPreparedMainTemplate(), ilUtil\getStyleSheetLocation(), and ilObjStyleSheet\getSyntaxStylePath().

Referenced by exportHTMLGlossaryTerms(), and exportHTMLMOB().

     : ilGlobalTemplateInterface {
        $this->global_screen->layout()->meta()->reset();
        $tpl = new ilGlobalTemplate($template_file, true, true, "components/ILIAS/COPage");
        $this->getPreparedMainTemplate($tpl);
        $tpl->addCss(\ilUtil::getStyleSheetLocation());
        $tpl->addCss(ilObjStyleSheet::getContentStylePath($this->getContentStyleId()));
        $tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
        return $tpl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderMob()

ilCOPageHTMLExport::renderMob ( \ilObjMediaObject  $mob_obj, string  $link_xml, array  $params  )

protected

Render Mob.

Definition at line 573 of file class.ilCOPageHTMLExport.php.

References ilObjMediaObject\getXML(), IL_MODE_ALIAS, and IL_MODE_OUTPUT.

Referenced by exportHTMLMOB().

     : string {
        $xml = "<dummy>" .
            $mob_obj->getXML(IL_MODE_ALIAS) .
            $mob_obj->getXML(IL_MODE_OUTPUT) .
            $link_xml .
            "</dummy>";

        return $this->xsl->process($xml, $params);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContentStyleId()

ilCOPageHTMLExport::setContentStyleId

(

int

$a_val

)

Definition at line 92 of file class.ilCOPageHTMLExport.php.

                                                 : void
    {
        $this->content_style_id = $a_val;
    }

Field Documentation

$content_style

ILIAS Style Content InternalDomainService ilCOPageHTMLExport::$content_style

protected

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

$content_style_dir

string ilCOPageHTMLExport::$content_style_dir = ""

protected

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

$content_style_id

int ilCOPageHTMLExport::$content_style_id = 0

protected

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

Referenced by getContentStyleId().

$content_style_img_dir

string ilCOPageHTMLExport::$content_style_img_dir = ""

protected

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

$css_dir

string ilCOPageHTMLExport::$css_dir = ""

protected

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

$exp_dir

string ilCOPageHTMLExport::$exp_dir = ""

protected

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

$files

array ilCOPageHTMLExport::$files = []

protected

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

$files_dir

string ilCOPageHTMLExport::$files_dir = ""

protected

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

$files_direct

array ilCOPageHTMLExport::$files_direct = []

protected

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

$global_screen

ILIAS GlobalScreen Services ilCOPageHTMLExport::$global_screen

protected

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

$glossary_terms

array ilCOPageHTMLExport::$glossary_terms = []

protected

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

$int_links

array ilCOPageHTMLExport::$int_links = []

protected

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

$js_dir

string ilCOPageHTMLExport::$js_dir = ""

protected

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

$js_yahoo_dir

string ilCOPageHTMLExport::$js_yahoo_dir = ""

protected

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

$log

ilLogger ilCOPageHTMLExport::$log

protected

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

$media_manager

ILIAS MediaObjects MediaObjectManager ilCOPageHTMLExport::$media_manager

protected

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

$media_service_dir

string ilCOPageHTMLExport::$media_service_dir = ""

protected

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

$mobs

array ilCOPageHTMLExport::$mobs = []

protected

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

$mobs_dir

string ilCOPageHTMLExport::$mobs_dir = ""

protected

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

$page_linker

ILIAS COPage PageLinker ilCOPageHTMLExport::$page_linker

protected

Definition at line 54 of file class.ilCOPageHTMLExport.php.

$q_ids

array ilCOPageHTMLExport::$q_ids = []

protected

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

$ref_id

int ilCOPageHTMLExport::$ref_id

protected

Definition at line 55 of file class.ilCOPageHTMLExport.php.

Referenced by __construct(), and exportHTMLMOB().

$services_dir

string ilCOPageHTMLExport::$services_dir = ""

protected

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

$skill_personal_service

ILIAS Skill Service SkillPersonalService ilCOPageHTMLExport::$skill_personal_service

protected

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

$skill_tree_service

ILIAS Skill Service SkillTreeService ilCOPageHTMLExport::$skill_tree_service

protected

Definition at line 52 of file class.ilCOPageHTMLExport.php.

$tex_dir

string ilCOPageHTMLExport::$tex_dir = ""

protected

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

$user

ilObjUser ilCOPageHTMLExport::$user

protected

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

$xsl

ILIAS COPage Xsl XslManager ilCOPageHTMLExport::$xsl

protected

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

---

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

• components/ILIAS/COPage/classes/class.ilCOPageHTMLExport.php