ILIAS\Wiki\Export\WikiHtmlExport Class Reference

Wiki HTML exporter class. More...

Collaboration diagram for ILIAS\Wiki\Export\WikiHtmlExport:

Public Member Functions
	__construct (\ilObjWiki $a_wiki)
	setMode (string $a_val)
	getMode ()
	buildExportFile (bool $print_version=false)
	Build export file. More...
	exportHTMLPages ()
	Export all pages. More...
	exportHTMLPagesPrint ()
	Export all pages as one print version. More...
	updateUserHTMLStatusForPageElements (int $a_total, int $a_cnt)
	Export user images. More...
	exportPageHTML (int $a_page_id, \ilGlobalPageTemplate $tpl)
	Export page html. More...
	getUserExportFile ()
	Get user export file. More...
	deliverLatest ()
	getLatest ()

Data Fields
const	MODE_DEFAULT = "html"
const	MODE_COMMENTS = "html_comments"
const	MODE_USER = "user_html"
const	MODE_USER_COMMENTS = "user_html_comments"

Protected Attributes
ILIAS components Export HTML ExportCollector	$collector
ILIAS Export HTML ExternalDomainService	$html_export
ILIAS components Export HTML Util	$export_util
ilDBInterface	$db
ilObjUser	$user
ilLanguage	$lng
ilTabsGUI	$tabs
ilObjWiki	$wiki
string	$mode = self::MODE_DEFAULT
ilLogger	$log
ilCOPageHTMLExport	$co_page_html_export
string	$export_dir
ILIAS GlobalScreen Services	$global_screen
ilGlobalTemplateInterface	$main_tpl
ilWikiUserHTMLExport	$user_html_exp
ILIAS Style Content Object ObjectFacade	$content_style_domain

Static Protected Attributes
static	$context_init = false

Detailed Description

Wiki HTML exporter class.

Author

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

Definition at line 30 of file WikiHtmlExport.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Wiki\Export\WikiHtmlExport::__construct

(

\ilObjWiki

$a_wiki

)

Definition at line 57 of file WikiHtmlExport.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->wiki = $a_wiki;
        $this->log = \ilLoggerFactory::getLogger('wiki');
        $this->global_screen = $DIC->globalScreen();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain()
            ->styleForRefId($a_wiki->getRefId());
        $this->html_export = $DIC->export()->domain()->html();
    }

References $DIC, ilLoggerFactory\getLogger(), ilObject\getRefId(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

buildExportFile()

ILIAS\Wiki\Export\WikiHtmlExport::buildExportFile

(

bool

$print_version = false

)

Build export file.

Exceptions

ilTemplateException

Exceptions

ilWikiExportException

Definition at line 92 of file WikiHtmlExport.php.

                                                                : ExportCollector
    {
        $global_screen = $this->global_screen;
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $this->log->debug("buildExportFile...");
 
        if (in_array($this->getMode(), [self::MODE_USER, self::MODE_USER_COMMENTS])) {
            $this->user_html_exp = new \ilWikiUserHTMLExport($this->wiki, $ilDB, $ilUser, ($this->getMode() === self::MODE_USER_COMMENTS));
        }
 
        $ascii_name = str_replace(" ", "_", ilFileUtils::getASCIIFilename($this->wiki->getTitle()));
 
        /*
        \ilExport::_createExportDirectory($this->wiki->getId(), $this->getMode(), "wiki");
        $exp_dir =
            \ilExport::_getExportDirectory($this->wiki->getId(), $this->getMode(), "wiki");
 
        if (in_array($this->getMode(), [self::MODE_USER, self::MODE_USER_COMMENTS])) {
            ilFileUtils::delDir($exp_dir, true);
        }*/
 
        if (in_array($this->getMode(), [self::MODE_USER, self::MODE_USER_COMMENTS])) {
            $subdir = $ascii_name;
        } else {
            $subdir = $this->wiki->getType() . "_" . $this->wiki->getId();
        }
 
        if ($print_version) {
            $subdir .= "print";
        }
 
        //$this->export_dir = $exp_dir . "/" . $subdir;
 
 
        $date = time();
        $zip_file_name = (in_array($this->getMode(), [self::MODE_USER, self::MODE_USER_COMMENTS]))
            ? $ascii_name . ".zip"
            : $date . "__" . IL_INST_ID . "__" . $this->wiki->getType() . "_" . $this->wiki->getId() . ".zip";
 
        $this->collector = $this->html_export->collector($this->wiki->getId(), $this->getMode());
        $this->collector->init($zip_file_name);
 
        $this->export_util = new \ILIAS\components\Export\HTML\Util("", "", $this->collector);
        $this->co_page_html_export = new \ilCOPageHTMLExport("", null, 0, $this->collector);
 
        $this->export_util->exportSystemStyle(
            [
                "icon_wiki.svg"
            ]
        );
        $eff_style_id = $this->content_style_domain->getEffectiveStyleId();
        $this->export_util->exportCOPageFiles($eff_style_id, "wiki");
        $this->co_page_html_export->setContentStyleId($eff_style_id);
 
        // export pages
        $this->log->debug("export pages");
        if (!self::$context_init) {
            $global_screen->tool()->context()->current()->addAdditionalData(
                \ilHTMLExportViewLayoutProvider::HTML_EXPORT_RENDERING,
                true
            );
            self::$context_init = true;
        }
        if ($print_version) {
            $this->exportHTMLPagesPrint();
        } else {
            $this->exportHTMLPages();
        }
        //$this->exportUserImages();
 
        $this->export_util->exportResourceFiles();
 
 
        // zip everything
        /*
        if (true) {
            // zip it all
            $zip_file = \ilExport::_getExportDirectory($this->wiki->getId(), $this->getMode(), "wiki") .
                "/" . $zip_file_name;
            $this->log->debug("zip: " . $zip_file);
            //var_dump($zip_file);
            //exit;
            $this->log->debug("zip, export dir: " . $this->export_dir);
            $this->log->debug("zip, export file: " . $zip_file);
            ilFileUtils::zip($this->export_dir, $zip_file);
            ilFileUtils::delDir($this->export_dir);
        }*/
        return $this->collector;
    }

References ILIAS\$db, $ilDB, ilFileUtils\getASCIIFilename(), ilHTMLExportViewLayoutProvider\HTML_EXPORT_RENDERING, and IL_INST_ID.

Here is the call graph for this function:

deliverLatest()

ILIAS\Wiki\Export\WikiHtmlExport::deliverLatest

(

)

Definition at line 374 of file WikiHtmlExport.php.

                                   : void
    {
        $fm = $this->html_export->fileManager();
        $latest = $fm->getLatestOfObjectIdAndType($this->wiki->getId(), $this->getMode());
        if ($latest) {
            $fm->deliver($latest);
        }
    }

exportHTMLPages()

ILIAS\Wiki\Export\WikiHtmlExport::exportHTMLPages

(

)

Export all pages.

Exceptions

ilTemplateException

Exceptions

ilWikiExportException

Definition at line 189 of file WikiHtmlExport.php.

                                     : void
    {
        global $DIC;
 
        $pages = \ilWikiPage::getAllWikiPages($this->wiki->getId());
 
        $cnt = 0;
 
        foreach ($pages as $page) {
            $tpl = new \ilGlobalPageTemplate($DIC->globalScreen(), $DIC->ui(), $DIC->http());
            $this->co_page_html_export->getPreparedMainTemplate($tpl);
            $this->log->debug("page: " . $page["id"]);
            if (\ilWikiPage::_exists("wpg", $page["id"])) {
                $this->log->debug("export page");
                $this->exportPageHTML($page["id"], $tpl);
                $this->log->debug("collect page elements");
                $this->co_page_html_export->collectPageElements("wpg:pg", $page["id"]);
            }
 
            if (in_array($this->getMode(), [self::MODE_USER, self::MODE_USER_COMMENTS])) {
                $cnt++;
                $this->log->debug("update status: " . $cnt);
                $this->user_html_exp->updateStatus((int) (50 / count($pages) * $cnt), \ilWikiUserHTMLExport::RUNNING);
            }
        }
        $this->co_page_html_export->exportPageElements(
            function (int $total, int $cnt): void {
                $this->updateUserHTMLStatusForPageElements($total, $cnt);
            }
        );
    }

References $DIC, ilPageObject\_exists(), ilWikiPage\getAllWikiPages(), and ilWikiUserHTMLExport\RUNNING.

Here is the call graph for this function:

exportHTMLPagesPrint()

ILIAS\Wiki\Export\WikiHtmlExport::exportHTMLPagesPrint

(

)

Export all pages as one print version.

Definition at line 224 of file WikiHtmlExport.php.

                                          : void
    {
        // collect page elements
        $pages = \ilWikiPage::getAllWikiPages($this->wiki->getId());
        foreach ($pages as $page) {
            if (\ilWikiPage::_exists("wpg", $page["id"])) {
                $this->co_page_html_export->collectPageElements("wpg:pg", $page["id"]);
            }
        }
        $this->co_page_html_export->exportPageElements();
 
        // render print view
        $wiki_gui = new \ilObjWikiGUI([], $this->wiki->getRefId(), true);
        $print_view = $wiki_gui->getPrintView(true);
        $print_view->setOffline(true);
        $html = $print_view->renderPrintView();
        $this->collector->addString($html, "index.html");
    }

References ilPageObject\_exists(), and ilWikiPage\getAllWikiPages().

Here is the call graph for this function:

exportPageHTML()

ILIAS\Wiki\Export\WikiHtmlExport::exportPageHTML	(	int	$a_page_id,
		\ilGlobalPageTemplate	$tpl
	)

Export page html.

Exceptions

ilWikiExportException

Definition at line 271 of file WikiHtmlExport.php.

     : void {
        $this->log->debug("Export page:" . $a_page_id);
        $lng = $this->lng;
        $ilTabs = $this->tabs;
 
        $ilTabs->clearTargets();
 
        //$this->tpl->loadStandardTemplate();
        $file = "wpg_" . $a_page_id . ".html";
        // return if file is already existing
        /*
        if (is_file($file)) {
            $this->log->debug("file already exists");
            return;
        }*/
 
        // page
        $this->log->debug("init page gui");
        $wpg_gui = new \ilWikiPageGUI(
            $a_page_id,
            0,
            $this->wiki->getRefId()
        );
        $wpg_gui->setOutputMode("offline");
        $page_content = $wpg_gui->showPage();
 
        // export template: page content
        $this->log->debug("init page gui-" . $this->getMode() . "-");
        $ep_tpl = new \ilTemplate(
            "tpl.export_page.html",
            true,
            true,
            "components/ILIAS/Wiki"
        );
        $ep_tpl->setVariable("PAGE_CONTENT", $page_content);
 
        $comments = (in_array($this->getMode(), [self::MODE_USER_COMMENTS, self::MODE_COMMENTS]))
            ? $wpg_gui->getCommentsHTMLExport()
            : "";
        $ep_tpl->setVariable("COMMENTS", $comments);
 
        // export template: right content
        $bl = new \ilWikiImportantPagesBlockGUI();
        $tpl->setRightContent($bl->getHTML(true));
 
 
        $this->log->debug("set title");
        $tpl->setTitle($this->wiki->getTitle());
        $tpl->setTitleIcon(
            \ilUtil::getImagePath("standard/icon_wiki.svg"),
            $lng->txt("obj_wiki")
        );
 
        $tpl->setContent($ep_tpl->get());
        $content = $tpl->printToString();
 
        // open file
        /*$this->log->debug("write file: " . $file);
        if (!($fp = fopen($file, 'wb+'))) {
            $this->log->error("Could not open " . $file . " for writing.");
            throw new \ilWikiExportException("Could not open \"" . $file . "\" for writing.");
        }*/
 
        // set file permissions
        /*$this->log->debug("set permissions");
        chmod($file, 0770);*/
 
        // write xml data into the file
        //fwrite($fp, $content);
        $this->collector->addString($content, $file);
 
        // close file
        //fclose($fp);
 
        if ($this->wiki->getStartPage() === $wpg_gui->getPageObject()->getTitle()) {
            $this->collector->addString($content, "index.html");
        }
    }

getLatest()

ILIAS\Wiki\Export\WikiHtmlExport::getLatest

(

)

Definition at line 383 of file WikiHtmlExport.php.

                               : ?ExportFile
    {
        return $this->html_export->fileManager()->getLatestOfObjectIdAndType($this->wiki->getId(), $this->getMode());
    }

getMode()

ILIAS\Wiki\Export\WikiHtmlExport::getMode

(

)

Definition at line 82 of file WikiHtmlExport.php.

                             : string
    {
        return $this->mode;
    }

getUserExportFile()

ILIAS\Wiki\Export\WikiHtmlExport::getUserExportFile

(

)

Get user export file.

Definition at line 356 of file WikiHtmlExport.php.

                                       : string
    {
        $exp_dir =
            \ilExport::_getExportDirectory($this->wiki->getId(), $this->getMode(), "wiki");
        $this->log->debug("dir: " . $exp_dir);
        if (!is_dir($exp_dir)) {
            return "";
        }
        foreach (new \DirectoryIterator($exp_dir) as $fileInfo) {
            $this->log->debug("file: " . $fileInfo->getFilename());
            if (pathinfo($fileInfo->getFilename(), PATHINFO_EXTENSION) === "zip") {
                $this->log->debug("return: " . $exp_dir . "/" . $fileInfo->getFilename());
                return $exp_dir . "/" . $fileInfo->getFilename();
            }
        }
        return "";
    }

References ilExport\_getExportDirectory().

Here is the call graph for this function:

setMode()

ILIAS\Wiki\Export\WikiHtmlExport::setMode

(

string

$a_val

)

Definition at line 76 of file WikiHtmlExport.php.

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

updateUserHTMLStatusForPageElements()

ILIAS\Wiki\Export\WikiHtmlExport::updateUserHTMLStatusForPageElements	(	int	$a_total,
		int	$a_cnt
	)

Export user images.

Callback for updating the export status during elements export (media objects, files, ...)

Definition at line 257 of file WikiHtmlExport.php.

     : void {
        if (in_array($this->getMode(), [self::MODE_USER, self::MODE_USER_COMMENTS])) {
            $this->user_html_exp->updateStatus((int) (50 + (50 / $a_total * $a_cnt)), \ilWikiUserHTMLExport::RUNNING);
        }
    }

References ilWikiUserHTMLExport\RUNNING.

Field Documentation

$co_page_html_export

ilCOPageHTMLExport ILIAS\Wiki\Export\WikiHtmlExport::$co_page_html_export

protected

Definition at line 47 of file WikiHtmlExport.php.

$collector

ILIAS components Export HTML ExportCollector ILIAS\Wiki\Export\WikiHtmlExport::$collector

protected

Definition at line 36 of file WikiHtmlExport.php.

$content_style_domain

ILIAS Style Content Object ObjectFacade ILIAS\Wiki\Export\WikiHtmlExport::$content_style_domain

protected

Definition at line 52 of file WikiHtmlExport.php.

$context_init

ILIAS\Wiki\Export\WikiHtmlExport::$context_init = false

staticprotected

Definition at line 55 of file WikiHtmlExport.php.

$db

ilDBInterface ILIAS\Wiki\Export\WikiHtmlExport::$db

protected

Definition at line 40 of file WikiHtmlExport.php.

$export_dir

string ILIAS\Wiki\Export\WikiHtmlExport::$export_dir

protected

Definition at line 48 of file WikiHtmlExport.php.

$export_util

ILIAS components Export HTML Util ILIAS\Wiki\Export\WikiHtmlExport::$export_util

protected

Definition at line 38 of file WikiHtmlExport.php.

$global_screen

ILIAS GlobalScreen Services ILIAS\Wiki\Export\WikiHtmlExport::$global_screen

protected

Definition at line 49 of file WikiHtmlExport.php.

$html_export

ILIAS Export HTML ExternalDomainService ILIAS\Wiki\Export\WikiHtmlExport::$html_export

protected

Definition at line 37 of file WikiHtmlExport.php.

$lng

ilLanguage ILIAS\Wiki\Export\WikiHtmlExport::$lng

protected

Definition at line 42 of file WikiHtmlExport.php.

$log

ilLogger ILIAS\Wiki\Export\WikiHtmlExport::$log

protected

Definition at line 46 of file WikiHtmlExport.php.

$main_tpl

ilGlobalTemplateInterface ILIAS\Wiki\Export\WikiHtmlExport::$main_tpl

protected

Definition at line 50 of file WikiHtmlExport.php.

$mode

string ILIAS\Wiki\Export\WikiHtmlExport::$mode = self::MODE_DEFAULT

protected

Definition at line 45 of file WikiHtmlExport.php.

$tabs

ilTabsGUI ILIAS\Wiki\Export\WikiHtmlExport::$tabs

protected

Definition at line 43 of file WikiHtmlExport.php.

$user

ilObjUser ILIAS\Wiki\Export\WikiHtmlExport::$user

protected

Definition at line 41 of file WikiHtmlExport.php.

$user_html_exp

ilWikiUserHTMLExport ILIAS\Wiki\Export\WikiHtmlExport::$user_html_exp

protected

Definition at line 51 of file WikiHtmlExport.php.

$wiki

ilObjWiki ILIAS\Wiki\Export\WikiHtmlExport::$wiki

protected

Definition at line 44 of file WikiHtmlExport.php.

MODE_COMMENTS

const ILIAS\Wiki\Export\WikiHtmlExport::MODE_COMMENTS = "html_comments"

Definition at line 33 of file WikiHtmlExport.php.

MODE_DEFAULT

const ILIAS\Wiki\Export\WikiHtmlExport::MODE_DEFAULT = "html"

Definition at line 32 of file WikiHtmlExport.php.

MODE_USER

const ILIAS\Wiki\Export\WikiHtmlExport::MODE_USER = "user_html"

Definition at line 34 of file WikiHtmlExport.php.

MODE_USER_COMMENTS

const ILIAS\Wiki\Export\WikiHtmlExport::MODE_USER_COMMENTS = "user_html_comments"

Definition at line 35 of file WikiHtmlExport.php.

---

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

• components/ILIAS/Wiki/Export/WikiHtmlExport.php