Collaboration diagram for ILIAS\Wiki\Export\BlogHtmlExport:

Public Member Functions
	setPrintVersion (bool $print_version)

	includeComments (bool $a_include_comments)

	exportHTML ()
	Export HTML. More...

	zipPackage ()

	exportHTMLPages (?string $a_link_template=null, ?\Closure $a_tpl_callback=null, ?\ilCOPageHTMLExport $a_co_page_html_export=null, string $a_index_name="index.html")
	Export all pages (note: this one is called from the portfolio html export!) More...

	exportHTMLPagesPrint ()
	Export all pages as one print version. More...

	collectAllPagesPageElements (\ilCOPageHTMLExport $co_page_html_export)

	delete ()

	getFilePath ()

Static Public Member Functions
static	buildExportLink (string $a_template, string $a_type, string $a_id, array $keywords)
	Build static export link. More...

Protected Member Functions
	init ()

	initDirectories ()

	exportUserImages ()

	getInitialisedTemplate (string $a_back_url="")
	Get initialised template. More...

	writeExportFile (string $a_file, \ilGlobalPageTemplate $a_tpl, string $a_content, string $a_right_content="", bool $a_back=false, string $comments="")
	Write HTML to file. More...

Protected Attributes
ILIAS components Export HTML ExportCollector	$collector

ilObjBlog	$blog

ilObjBlogGUI	$blog_gui

string	$export_dir

string	$sub_dir

string	$target_dir

ILIAS GlobalScreen Services	$global_screen

Util	$export_util

ilCOPageHTMLExport	$co_page_html_export

ilLanguage	$lng

ilTabsGUI	$tabs

array	$items

array	$keywords

bool	$include_comments = false

bool	$print_version = false

ILIAS Style Content Object ObjectFacade	$content_style_domain

Static Protected Attributes
static array	$keyword_export_map

static bool	$export_key_set = false

Detailed Description

Definition at line 26 of file BlogHtmlExport.php.

Member Function Documentation

◆ buildExportLink()

static ILIAS\Wiki\Export\BlogHtmlExport::buildExportLink	(	string	$a_template,
		string	$a_type,
		string	$a_id,
		array	$keywords
	)

static

Build static export link.

Definition at line 323 of file BlogHtmlExport.php.

      : string {
         switch ($a_type) {
             case "list":
                 $a_type = "m";
                 break;
 
             case "keyword":
                 if (!isset(self::$keyword_export_map)) {
                     self::$keyword_export_map = array_flip(array_keys($keywords));
                 }
                 $a_id = (string) (self::$keyword_export_map[$a_id] ?? "");
                 $a_type = "k";
                 break;
 
             default:
                 $a_type = "p";
                 break;
         }
 
         return str_replace(array("{TYPE}", "{ID}"), array($a_type, $a_id), $a_template);
     }

◆ collectAllPagesPageElements()

ILIAS\Wiki\Export\BlogHtmlExport::collectAllPagesPageElements ( \ilCOPageHTMLExport $co_page_html_export )

Definition at line 310 of file BlogHtmlExport.php.

References ilPageObject\_exists(), ilCOPageHTMLExport\collectPageElements(), and ilBlogPosting\getAllPostings().

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

                                                                                          : void
     {
         $pages = \ilBlogPosting::getAllPostings($this->blog->getId(), 0);
         foreach ($pages as $page) {
             if (\ilBlogPosting::_exists("blp", $page["id"])) {
                 $co_page_html_export->collectPageElements("blp:pg", $page["id"]);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ILIAS\Wiki\Export\BlogHtmlExport::delete ( )

Definition at line 426 of file BlogHtmlExport.php.

                             : void
     {
         $this->collector->delete();
     }

◆ exportHTML()

ILIAS\Wiki\Export\BlogHtmlExport::exportHTML ( )

Export HTML.

Exceptions

Definition at line 116 of file BlogHtmlExport.php.

References ILIAS\Wiki\Export\BlogHtmlExport\exportHTMLPages(), ILIAS\Wiki\Export\BlogHtmlExport\exportHTMLPagesPrint(), ILIAS\Wiki\Export\BlogHtmlExport\initDirectories(), and ILIAS\Wiki\Export\BlogHtmlExport\zipPackage().

                                 : string
     {
         $this->initDirectories();
 
         $this->export_util->exportSystemStyle(
             [
                 "icon_blog.svg"
             ]
         );
 
         $this->export_util->exportCOPageFiles(
             $this->content_style_domain->getEffectiveStyleId(),
             "blog"
         );
         /*
                 \ilObjUser::copyProfilePicturesToDirectory($this->blog->getOwner(), $this->target_dir);
         */
         // export pages
         if ($this->print_version) {
             $this->exportHTMLPagesPrint();
         } else {
             $this->exportHTMLPages();
         }
         /*
                 // export comments user images
                 $this->exportUserImages();
         */
         $this->export_util->exportResourceFiles();
         $this->co_page_html_export->exportPageElements();
 
         return $this->zipPackage();
     }

Here is the call graph for this function:

◆ exportHTMLPages()

ILIAS\Wiki\Export\BlogHtmlExport::exportHTMLPages	(	?string	$a_link_template = `null`,
		?\Closure	$a_tpl_callback = `null`,
		?\ilCOPageHTMLExport	$a_co_page_html_export = `null`,
		string	$a_index_name = `"index.html"`
	)

Export all pages (note: this one is called from the portfolio html export!)

Exceptions

Definition at line 177 of file BlogHtmlExport.php.

References $comments, ILIAS\Wiki\Export\BlogHtmlExport\$include_comments, ilPageObject\_exists(), ilBlogPosting\getAllPostings(), ILIAS\Wiki\Export\BlogHtmlExport\getInitialisedTemplate(), IL_CAL_DATE, null, and ILIAS\Wiki\Export\BlogHtmlExport\writeExportFile().

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

      : void {
         if (!$a_link_template) {
             $a_link_template = "bl{TYPE}_{ID}.html";
         }
 
         if ($a_co_page_html_export) {
             $this->co_page_html_export = $a_co_page_html_export;
         }
 
         // lists
 
         // global nav
         $nav = $this->blog_gui->renderNavigation("", "", $a_link_template);
 
         // month list
         $has_index = false;
         foreach (array_keys($this->items) as $month) {
             $list = $this->blog_gui->renderList($this->items[$month], "render", $a_link_template, false, $this->target_dir);
 
             if (!$list) {
                 continue;
             }
 
             if (!$a_tpl_callback) {
                 $tpl = $this->getInitialisedTemplate();
             } else {
                 $tpl = $a_tpl_callback();
             }
 
             $file = self::buildExportLink($a_link_template, "list", $month, $this->keywords);
             $file = $this->writeExportFile($file, $tpl, $list, $nav);
 
             if (!$has_index) {
                 $file = $this->writeExportFile($a_index_name, $tpl, $list, $nav);
                 $has_index = true;
             }
         }
 
         // keywords
         foreach (array_keys($this->blog_gui->getKeywords(false)) as $keyword) {
             $list_items = $this->blog_gui->filterItemsByKeyword($this->items, $keyword);
             $list = $this->blog_gui->renderList($list_items, "render", $a_link_template, false, $this->target_dir);
 
             if (!$list) {
                 continue;
             }
 
             if (!$a_tpl_callback) {
                 $tpl = $this->getInitialisedTemplate();
             } else {
                 $tpl = $a_tpl_callback();
             }
 
             $file = self::buildExportLink($a_link_template, "keyword", $keyword, $this->keywords);
             $file = $this->writeExportFile($file, $tpl, $list, $nav);
         }
 
 
         // single postings
 
         $pages = \ilBlogPosting::getAllPostings($this->blog->getId(), 0);
         foreach ($pages as $page) {
             if (\ilBlogPosting::_exists("blp", $page["id"])) {
                 $blp_gui = new \ilBlogPostingGUI(0, null, $page["id"]);
                 $blp_gui->setOutputMode("offline");
                 $blp_gui->setFullscreenLink("fullscreen.html"); // #12930 - see page.xsl
                 $blp_gui->add_date = true;
                 $page_content = $blp_gui->showPage();
 
                 $back = self::buildExportLink(
                     $a_link_template,
                     "list",
                     substr($page["created"]->get(IL_CAL_DATE), 0, 7),
                     $this->keywords
                 );
 
                 $file = self::buildExportLink($a_link_template, "posting", (string) $page["id"], $this->keywords);
 
                 if (!$a_tpl_callback) {
                     $tpl = $this->getInitialisedTemplate();
                 } else {
                     $tpl = $a_tpl_callback();
                 }
 
                 $comments = ($this->include_comments)
                     ? $blp_gui->getCommentsHTMLExport()
                     : "";
 
                 // posting nav
                 $nav = $this->blog_gui->renderNavigation(
                     "",
                     "",
                     $a_link_template,
                     false,
                     $page["id"]
                 );
 
                 $this->writeExportFile($file, $tpl, $page_content, $nav, (bool) $back, $comments);
 
                 $this->co_page_html_export->collectPageElements("blp:pg", $page["id"]);
             }
         }
 
         if (!$has_index) {
             if (!$a_tpl_callback) {
                 $tpl = $this->getInitialisedTemplate();
             } else {
                 $tpl = $a_tpl_callback();
             }
             $file = $this->writeExportFile($a_index_name, $tpl, "", $nav);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportHTMLPagesPrint()

ILIAS\Wiki\Export\BlogHtmlExport::exportHTMLPagesPrint ( )

Export all pages as one print version.

Definition at line 298 of file BlogHtmlExport.php.

References ILIAS\Wiki\Export\BlogHtmlExport\collectAllPagesPageElements().

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

                                           : void
     {
         $this->collectAllPagesPageElements($this->co_page_html_export);
 
         // render print view
         $print_view = $this->blog_gui->getPrintView();
         $print_view->setOffline(true);
         $html = $print_view->renderPrintView();
         file_put_contents($this->target_dir . "/index.html", $html);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportUserImages()

ILIAS\Wiki\Export\BlogHtmlExport::exportUserImages ( )

protected

Definition at line 149 of file BlogHtmlExport.php.

                                          : void
     {
         if ($this->include_comments) {
             $user_export = new \ILIAS\Notes\Export\UserImageExporter();
             $user_export->exportUserImagesForRepObjId($this->target_dir, $this->blog->getId());
         }
     }

◆ getFilePath()

ILIAS\Wiki\Export\BlogHtmlExport::getFilePath ( )

Definition at line 431 of file BlogHtmlExport.php.

                                  : string
     {
         return $this->collector->getFilePath();
     }

◆ getInitialisedTemplate()

ILIAS\Wiki\Export\BlogHtmlExport::getInitialisedTemplate ( string $a_back_url = "" )

protected

Get initialised template.

Definition at line 353 of file BlogHtmlExport.php.

References $DIC, ilObjStyleSheet\getExportContentStylePath(), ilUtil\getStyleSheetLocation(), ILIAS\Repository\lng(), and ilPCQuestion\resetInitialState().

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

      : \ilGlobalPageTemplate {
         global $DIC;
 
         $this->global_screen->layout()->meta()->reset();
 
         $location_stylesheet = \ilUtil::getStyleSheetLocation();
         $this->global_screen->layout()->meta()->addCss($location_stylesheet);
         $this->global_screen->layout()->meta()->addCss(
             \ilObjStyleSheet::getExportContentStylePath()
         );
         \ilPCQuestion::resetInitialState();
 
         $tabs = $DIC->tabs();
         $tabs->clearTargets();
         $tabs->clearSubTabs();
         if ($a_back_url) {
             $tabs->setBackTarget($this->lng->txt("back"), $a_back_url);
         }
         $tpl = new \ilGlobalPageTemplate($DIC->globalScreen(), $DIC->ui(), $DIC->http());
 
         $this->co_page_html_export->getPreparedMainTemplate($tpl);
 
         $this->blog_gui->renderFullscreenHeader($tpl, $this->blog->getOwner(), true);
 
         return $tpl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ includeComments()

ILIAS\Wiki\Export\BlogHtmlExport::includeComments ( bool $a_include_comments )

Definition at line 98 of file BlogHtmlExport.php.

      : void {
         $this->include_comments = $a_include_comments;
     }

◆ init()

ILIAS\Wiki\Export\BlogHtmlExport::init ( )

protected

Definition at line 89 of file BlogHtmlExport.php.

                              : void
     {
     }

◆ initDirectories()

ILIAS\Wiki\Export\BlogHtmlExport::initDirectories ( )

protected

Definition at line 104 of file BlogHtmlExport.php.

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

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

                                         : void
     {
         // initialize temporary target directory
         ilFileUtils::delDir($this->target_dir);
         ilFileUtils::makeDir($this->target_dir);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPrintVersion()

ILIAS\Wiki\Export\BlogHtmlExport::setPrintVersion ( bool $print_version )

Definition at line 93 of file BlogHtmlExport.php.

References ILIAS\Wiki\Export\BlogHtmlExport\$print_version.

                                                         : void
     {
         $this->print_version = $print_version;
     }

◆ writeExportFile()

ILIAS\Wiki\Export\BlogHtmlExport::writeExportFile	(	string	$a_file,
		\ilGlobalPageTemplate	$a_tpl,
		string	$a_content,
		string	$a_right_content = `""`,
		bool	$a_back = `false`,
		string	$comments = `""`
	)

protected

Write HTML to file.

Exceptions

Definition at line 386 of file BlogHtmlExport.php.

References $comments, ilGlobalPageTemplate\printToString(), ilGlobalPageTemplate\setContent(), and ilGlobalPageTemplate\setRightContent().

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

      : string {
         $file = $this->target_dir . "/" . $a_file;
 
         // export template: page content
         $ep_tpl = new \ilTemplate(
             "tpl.export_page.html",
             true,
             true,
             "components/ILIAS/Blog"
         );
         if ($a_back) {
             $ep_tpl->setVariable("PAGE_CONTENT", $a_content);
             $ep_tpl->setVariable("COMMENTS", $comments);
         } else {
             $ep_tpl->setVariable("LIST", $a_content);
         }
         $a_tpl->setContent($ep_tpl->get());
         unset($ep_tpl);
 
         // template: right content
         if ($a_right_content) {
             $a_tpl->setRightContent($a_right_content);
         }
 
         $content = $a_tpl->printToString();
 
         // open file
         //        file_put_contents($file, $content);
         $this->collector->addString($content, $a_file);
 
         return $file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zipPackage()

ILIAS\Wiki\Export\BlogHtmlExport::zipPackage ( )

Definition at line 157 of file BlogHtmlExport.php.

References ILIAS\Wiki\Export\BlogHtmlExport\$include_comments, ilExport\_getExportDirectory(), ilFileUtils\delDir(), IL_INST_ID, and ilFileUtils\zip().

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

                                 : string
     {
         // zip it all
         $date = time();
         $type = ($this->include_comments)
             ? "html_comments"
             : "html";
         $zip_file = \ilExport::_getExportDirectory($this->blog->getId(), $type, "blog") .
             "/" . $date . "__" . IL_INST_ID . "__" .
             $this->blog->getType() . "_" . $this->blog->getId() . ".zip";
         ilFileUtils::zip($this->target_dir, $zip_file);
         ilFileUtils::delDir($this->target_dir);
         return $zip_file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $blog

ilObjBlog ILIAS\Wiki\Export\BlogHtmlExport::$blog

protected

Definition at line 29 of file BlogHtmlExport.php.

◆ $blog_gui

ilObjBlogGUI ILIAS\Wiki\Export\BlogHtmlExport::$blog_gui

protected

Definition at line 30 of file BlogHtmlExport.php.

◆ $co_page_html_export

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

protected

Definition at line 36 of file BlogHtmlExport.php.

◆ $collector

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

protected

Definition at line 28 of file BlogHtmlExport.php.

◆ $content_style_domain

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

protected

Definition at line 45 of file BlogHtmlExport.php.

◆ $export_dir

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

protected

Definition at line 31 of file BlogHtmlExport.php.

◆ $export_key_set

bool ILIAS\Wiki\Export\BlogHtmlExport::$export_key_set = false

staticprotected

Definition at line 44 of file BlogHtmlExport.php.

◆ $export_util

Util ILIAS\Wiki\Export\BlogHtmlExport::$export_util

protected

Definition at line 35 of file BlogHtmlExport.php.

◆ $global_screen

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

protected

Definition at line 34 of file BlogHtmlExport.php.

◆ $include_comments

bool ILIAS\Wiki\Export\BlogHtmlExport::$include_comments = false

protected

Definition at line 42 of file BlogHtmlExport.php.

Referenced by ILIAS\Wiki\Export\BlogHtmlExport\exportHTMLPages(), and ILIAS\Wiki\Export\BlogHtmlExport\zipPackage().

◆ $items

array ILIAS\Wiki\Export\BlogHtmlExport::$items

protected

Definition at line 39 of file BlogHtmlExport.php.

◆ $keyword_export_map

array ILIAS\Wiki\Export\BlogHtmlExport::$keyword_export_map

staticprotected

Definition at line 40 of file BlogHtmlExport.php.

◆ $keywords

array ILIAS\Wiki\Export\BlogHtmlExport::$keywords

protected

Definition at line 41 of file BlogHtmlExport.php.

◆ $lng

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

protected

Definition at line 37 of file BlogHtmlExport.php.

◆ $print_version

bool ILIAS\Wiki\Export\BlogHtmlExport::$print_version = false

protected

Definition at line 43 of file BlogHtmlExport.php.

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

◆ $sub_dir

string ILIAS\Wiki\Export\BlogHtmlExport::$sub_dir

protected

Definition at line 32 of file BlogHtmlExport.php.

◆ $tabs

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

protected

Definition at line 38 of file BlogHtmlExport.php.

◆ $target_dir

string ILIAS\Wiki\Export\BlogHtmlExport::$target_dir

protected

Definition at line 33 of file BlogHtmlExport.php.

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

components/ILIAS/Blog/Export/BlogHtmlExport.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ buildExportLink()

◆ collectAllPagesPageElements()

◆ delete()

◆ exportHTML()

◆ exportHTMLPages()

◆ exportHTMLPagesPrint()

◆ exportUserImages()

◆ getFilePath()

◆ getInitialisedTemplate()

◆ includeComments()

◆ init()

◆ initDirectories()

◆ setPrintVersion()

◆ writeExportFile()

◆ zipPackage()

Field Documentation

◆ $blog

◆ $blog_gui

◆ $co_page_html_export

◆ $collector

◆ $content_style_domain

◆ $export_dir

◆ $export_key_set

◆ $export_util

◆ $global_screen

◆ $include_comments

◆ $items

◆ $keyword_export_map

◆ $keywords

◆ $lng

◆ $print_version

◆ $sub_dir

◆ $tabs

◆ $target_dir