ilWikiHTMLExport Class Reference

Wiki HTML exporter class. More...

Collaboration diagram for ilWikiHTMLExport:

Public Member Functions
	__construct ($a_wiki)
	Constructor. More...
	setMode ($a_val)
	Set mode. More...
	getMode ()
	Get mode. More...
	buildExportFile ()
	Build export file. More...
	exportHTMLPages ()
	Export all pages. More...
	updateUserHTMLStatusForPageElements ($a_total, $a_cnt)
	Callback for updating the export status during elements export (media objects, files, ...) More...
	exportPageHTML ($a_page_id)
	Export page html. More...
	getUserExportFile ()
	Get user export file. More...

Data Fields
const	MODE_DEFAULT = "html"
const	MODE_USER = "user_html"

Protected Attributes
	$db
	$user
	$lng
	$tabs
	$wiki
	$mode = self::MODE_DEFAULT
	$log

Detailed Description

Wiki HTML exporter class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$ /

Definition at line 11 of file class.ilWikiHTMLExport.php.

Constructor & Destructor Documentation

__construct()

ilWikiHTMLExport::__construct

(

$a_wiki

)

Constructor.

Parameters

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

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

    {
        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');
    }

Here is the call graph for this function:

Member Function Documentation

buildExportFile()

ilWikiHTMLExport::buildExportFile

(

)

Build export file.

Parameters

Definition at line 87 of file class.ilWikiHTMLExport.php.

References $db, $ilDB, $ilUser, $user, ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), ilUtil\delDir(), exportHTMLPages(), ilUtil\getASCIIFilename(), ilObjStyleSheet\getEffectiveContentStyleId(), ilMathJax\getInstance(), getMode(), ilUtil\makeDir(), ilMathJax\PURPOSE_EXPORT, time, and ilUtil\zip().

    {
        $this->log->debug("buildExportFile...");
        //init the mathjax rendering for HTML export
        include_once './Services/MathJax/classes/class.ilMathJax.php';
        ilMathJax::getInstance()->init(ilMathJax::PURPOSE_EXPORT);

        if ($this->getMode() == self::MODE_USER) {
            $ilDB = $this->db;
            $ilUser = $this->user;
            include_once("./Modules/Wiki/classes/class.ilWikiUserHTMLExport.php");
            $this->user_html_exp = new ilWikiUserHTMLExport($this->wiki, $ilDB, $ilUser);
        }

        $ascii_name = str_replace(" ", "_", ilUtil::getASCIIFilename($this->wiki->getTitle()));

        // create export file
        include_once("./Services/Export/classes/class.ilExport.php");
        ilExport::_createExportDirectory($this->wiki->getId(), $this->getMode(), "wiki");
        $exp_dir =
            ilExport::_getExportDirectory($this->wiki->getId(), $this->getMode(), "wiki");

        if ($this->getMode() == self::MODE_USER) {
            ilUtil::delDir($exp_dir, true);
        }

        if ($this->getMode() == self::MODE_USER) {
            $this->subdir = $ascii_name;
        } else {
            $this->subdir = $this->wiki->getType() . "_" . $this->wiki->getId();
        }
        $this->export_dir = $exp_dir . "/" . $this->subdir;
        //echo "+".$this->export_dir."+";
        // initialize temporary target directory
        ilUtil::delDir($this->export_dir);
        ilUtil::makeDir($this->export_dir);

        $this->log->debug("export directory: " . $this->export_dir);

        // system style html exporter
        include_once("./Services/Style/System/classes/class.ilSystemStyleHTMLExport.php");
        $this->sys_style_html_export = new ilSystemStyleHTMLExport($this->export_dir);
        $this->sys_style_html_export->addImage("icon_wiki.svg");
        $this->sys_style_html_export->export();

        // init co page html exporter
        include_once("./Services/COPage/classes/class.ilCOPageHTMLExport.php");
        $this->co_page_html_export = new ilCOPageHTMLExport($this->export_dir);
        $this->co_page_html_export->setContentStyleId(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->wiki->getStyleSheetId(),
                $this->wiki->getType()
            )
        );
        $this->co_page_html_export->createDirectories();
        $this->co_page_html_export->exportStyles();
        $this->co_page_html_export->exportSupportScripts();

        // export pages
        $this->log->debug("export pages");
        $this->exportHTMLPages();

        $date = time();
        $zip_file_name = ($this->getMode() == self::MODE_USER)
            ? $ascii_name . ".zip"
            : $date . "__" . IL_INST_ID . "__" . $this->wiki->getType() . "_" . $this->wiki->getId() . ".zip";

        // 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);
            ilUtil::zip($this->export_dir, $zip_file);
            ilUtil::delDir($this->export_dir);
        }
    }

Here is the call graph for this function:

exportHTMLPages()

ilWikiHTMLExport::exportHTMLPages

(

)

Export all pages.

Definition at line 168 of file class.ilWikiHTMLExport.php.

References ilPageObject\_exists(), exportPageHTML(), ilWikiPage\getAllWikiPages(), getMode(), ilWikiUserHTMLExport\RUNNING, and updateUserHTMLStatusForPageElements().

Referenced by buildExportFile().

    {
        $pages = ilWikiPage::getAllWikiPages($this->wiki->getId());

        include_once("./Services/COPage/classes/class.ilPageContentUsage.php");
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
        $cnt = 0;
        foreach ($pages as $page) {
            $this->log->debug("page: " . $page["id"]);
            if (ilWikiPage::_exists("wpg", $page["id"])) {
                $this->log->debug("export page");
                $this->exportPageHTML($page["id"]);
                $this->log->debug("collect page elements");
                $this->co_page_html_export->collectPageElements("wpg:pg", $page["id"]);
            }

            if ($this->getMode() == self::MODE_USER) {
                $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($this->updateUserHTMLStatusForPageElements);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportPageHTML()

ilWikiHTMLExport::exportPageHTML

(

$a_page_id

)

Export page html.

Definition at line 209 of file class.ilWikiHTMLExport.php.

References $file, $ilUser, $lng, $tabs, and $user.

Referenced by exportHTMLPages().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilTabs = $this->tabs;

        $ilTabs->clearTargets();
        
        $this->tpl = $this->co_page_html_export->getPreparedMainTemplate();
        
        $this->tpl->getStandardTemplate();
        $file = $this->export_dir . "/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");
        include_once("./Modules/Wiki/classes/class.ilWikiPageGUI.php");
        $wpg_gui = new ilWikiPageGUI($a_page_id);
        $wpg_gui->setOutputMode("offline");
        $page_content = $wpg_gui->showPage();

        // export template: page content
        $this->log->debug("init page gui");
        $ep_tpl = new ilTemplate(
            "tpl.export_page.html",
            true,
            true,
            "Modules/Wiki"
        );
        $ep_tpl->setVariable("PAGE_CONTENT", $page_content);
        
        // export template: right content
        include_once("./Modules/Wiki/classes/class.ilWikiImportantPagesBlockGUI.php");
        $bl = new ilWikiImportantPagesBlockGUI();
        $ep_tpl->setVariable("RIGHT_CONTENT", $bl->getHTML(true));

        // workaround
        //              $this->tpl->setVariable("MAINMENU", "<div style='min-height:40px;'></div>");
        $this->tpl->setVariable("MAINMENU", "");

        $this->log->debug("set title");
        $this->tpl->setTitle($this->wiki->getTitle());
        $this->tpl->setTitleIcon(
            "./images/icon_wiki.svg",
            $lng->txt("obj_wiki")
        );

        $this->tpl->setContent($ep_tpl->get());
        //$this->tpl->fillMainContent();
        $content = $this->tpl->get(
            "DEFAULT",
            false,
            false,
            false,
            true,
            true,
            true
        );

        //echo htmlentities($content); exit;
        // open file
        $this->log->debug("write file: " . $file);
        if (!($fp = @fopen($file, "w+"))) {
            $this->log->error("Could not open " . $file . " for writing.");
            include_once("./Modules/Wiki/exceptions/class.ilWikiExportException.php");
            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);

        // close file
        fclose($fp);

        if ($this->wiki->getStartPage() == $wpg_gui->getPageObject()->getTitle()) {
            copy($file, $this->export_dir . "/index.html");
        }
    }

Here is the caller graph for this function:

getMode()

ilWikiHTMLExport::getMode

(

)

Get mode.

Returns

int MODE_DEFAULT|MODE_USER

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

References $mode.

Referenced by buildExportFile(), exportHTMLPages(), getUserExportFile(), and updateUserHTMLStatusForPageElements().

    {
        return $this->mode;
    }

Here is the caller graph for this function:

getUserExportFile()

ilWikiHTMLExport::getUserExportFile

(

)

Get user export file.

Parameters

Definition at line 302 of file class.ilWikiHTMLExport.php.

References ilExport\_getExportDirectory(), and getMode().

    {
        include_once("./Services/Export/classes/class.ilExport.php");
        $exp_dir =
            ilExport::_getExportDirectory($this->wiki->getId(), $this->getMode(), "wiki");
        $this->log->debug("dir: " . $exp_dir);
        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 false;
    }

Here is the call graph for this function:

setMode()

ilWikiHTMLExport::setMode

(

$a_val

)

Set mode.

Parameters

int

$a_val

MODE_DEFAULT|MODE_USER

Definition at line 66 of file class.ilWikiHTMLExport.php.

    {
        $this->mode = $a_val;
    }

updateUserHTMLStatusForPageElements()

ilWikiHTMLExport::updateUserHTMLStatusForPageElements	(		$a_total,
			$a_cnt
	)

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

Parameters

Definition at line 198 of file class.ilWikiHTMLExport.php.

References getMode(), and ilWikiUserHTMLExport\RUNNING.

Referenced by exportHTMLPages().

    {
        if ($this->getMode() == self::MODE_USER) {
            $this->user_html_exp->updateStatus((int) 50 + (50 / count($a_total) * $a_cnt), ilWikiUserHTMLExport::RUNNING);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilWikiHTMLExport::$db

protected

Definition at line 16 of file class.ilWikiHTMLExport.php.

Referenced by buildExportFile().

$lng

ilWikiHTMLExport::$lng

protected

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

Referenced by exportPageHTML().

$log

ilWikiHTMLExport::$log

protected

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

$mode

ilWikiHTMLExport::$mode = self::MODE_DEFAULT

protected

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

Referenced by getMode().

$tabs

ilWikiHTMLExport::$tabs

protected

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

Referenced by exportPageHTML().

$user

ilWikiHTMLExport::$user

protected

Definition at line 21 of file class.ilWikiHTMLExport.php.

Referenced by buildExportFile(), and exportPageHTML().

$wiki

ilWikiHTMLExport::$wiki

protected

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

MODE_DEFAULT

const ilWikiHTMLExport::MODE_DEFAULT = "html"

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

MODE_USER

const ilWikiHTMLExport::MODE_USER = "user_html"

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

Referenced by ilWikiUserHTMLExport\deliverFile(), and ilWikiUserHTMLExport\startUserHTMLExport().

---

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

• Modules/Wiki/classes/class.ilWikiHTMLExport.php