This exports the whole. More...

Collaboration diagram for ILIAS\Notes\Export\NotesHtmlExport:

Public Member Functions
	__construct (int $type, int $user_id, array $author_ids)

	exportHTML ($page_content)
	Export HTML. More...

	zipPackage ()

	exportPage (string $content)
	Export page. More...

Protected Member Functions
	initDirectories ()

	exportUserImages ()

	getInitialisedTemplate ()
	Get initialised template. More...

	writeExportFile (string $a_file, \ilGlobalPageTemplate $a_tpl, string $a_content)
	Write HTML to file. More...

Protected Attributes
ilLanguage	$lng

int	$user_id

int	$type

array	$author_ids

string	$export_dir

string	$sub_dir

string	$target_dir

ILIAS GlobalScreen Services	$global_screen

ILIAS components Export HTML Util	$export_util

Static Protected Attributes
static	$export_key_set = false

Detailed Description

This exports the whole.

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notes\Export\NotesHtmlExport::__construct	(	int	$type,
		int	$user_id,
		array	$author_ids
	)

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

References ILIAS\Notes\Export\NotesHtmlExport\$author_ids, $DIC, ILIAS\Notes\Export\NotesHtmlExport\$sub_dir, ILIAS\Notes\Export\NotesHtmlExport\$type, ILIAS\Notes\Export\NotesHtmlExport\$user_id, ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), ilHTMLExportViewLayoutProvider\HTML_EXPORT_RENDERING, and ILIAS\Repository\lng().

       {
         global $DIC;
 
         $this->type = $type;
         $this->author_ids = $author_ids;
         $this->user_id = $user_id;
         $this->lng = $DIC->language();
 
         \ilExport::_createExportDirectory($user_id, "html_notes", "usr");
         $exp_dir = \ilExport::_getExportDirectory($user_id, "html_notes", "usr");
         $sub_dir = "user_notes";
 
         $this->export_dir = $exp_dir;
         $this->sub_dir = $sub_dir;
         $this->target_dir = $exp_dir . "/" . $sub_dir;
 
         $this->global_screen = $DIC->globalScreen();
         $this->export_util = new \ILIAS\components\Export\HTML\Util($exp_dir, $sub_dir);
         if (!self::$export_key_set) {
             self::$export_key_set = true;
             $this->global_screen->tool()->context()->current()->addAdditionalData(
                 \ilHTMLExportViewLayoutProvider::HTML_EXPORT_RENDERING,
                 true
             );
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ exportHTML()

ILIAS\Notes\Export\NotesHtmlExport::exportHTML ( $page_content )

Export HTML.

Exceptions

Definition at line 88 of file class.NotesHtmlExport.php.

References ilFileDelivery\deliverFileLegacy(), ILIAS\Notes\Export\NotesHtmlExport\exportPage(), ILIAS\Notes\Export\NotesHtmlExport\exportUserImages(), ILIAS\Notes\Export\NotesHtmlExport\initDirectories(), and ILIAS\Notes\Export\NotesHtmlExport\zipPackage().

                                              : void
     {
         $this->initDirectories();
         $this->export_util->exportSystemStyle();
 
         $this->exportPage($page_content);
 
         // export comments user images
         $this->exportUserImages();
         $zip = $this->zipPackage();
         \ilFileDelivery::deliverFileLegacy($zip, "user_notes.zip");
     }

Here is the call graph for this function:

◆ exportPage()

ILIAS\Notes\Export\NotesHtmlExport::exportPage ( string $content )

Export page.

Exceptions

Definition at line 121 of file class.NotesHtmlExport.php.

References ILIAS\Notes\Export\NotesHtmlExport\getInitialisedTemplate(), ILIAS\Repository\lng(), ILIAS\Notes\Note\PRIVATE, and ILIAS\Notes\Export\NotesHtmlExport\writeExportFile().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\exportHTML().

      : void {
         $tpl = $this->getInitialisedTemplate();
 
         $tpl->setTitle(($this->type === Note::PRIVATE)
             ? $this->lng->txt("notes")
             : $this->lng->txt("notes_comments"));
 
         $this->writeExportFile("index.html", $tpl, $content);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportUserImages()

ILIAS\Notes\Export\NotesHtmlExport::exportUserImages ( )

protected

Definition at line 101 of file class.NotesHtmlExport.php.

Referenced by ILIAS\Notes\Export\NotesHtmlExport\exportHTML().

                                          : void
     {
         $user_export = new \ILIAS\Notes\Export\UserImageExporter();
         $user_export->exportUserImages($this->target_dir, $this->author_ids);
     }

Here is the caller graph for this function:

◆ getInitialisedTemplate()

ILIAS\Notes\Export\NotesHtmlExport::getInitialisedTemplate ( )

protected

Get initialised template.

Definition at line 136 of file class.NotesHtmlExport.php.

References $DIC, and ilUtil\getStyleSheetLocation().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\exportPage().

                                                : \ilGlobalPageTemplate
     {
         global $DIC;
 
         $this->global_screen->layout()->meta()->reset();
 
         $location_stylesheet = \ilUtil::getStyleSheetLocation();
         $this->global_screen->layout()->meta()->addCss($location_stylesheet);
 
         $tabs = $DIC->tabs();
         $tabs->clearTargets();
         $tabs->clearSubTabs();
 
         $toolbar = $DIC->toolbar();
         $toolbar->setItems([]);
 
         return new \ilGlobalPageTemplate($DIC->globalScreen(), $DIC->ui(), $DIC->http());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDirectories()

ILIAS\Notes\Export\NotesHtmlExport::initDirectories ( )

protected

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

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

Referenced by ILIAS\Notes\Export\NotesHtmlExport\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:

◆ writeExportFile()

ILIAS\Notes\Export\NotesHtmlExport::writeExportFile	(	string	$a_file,
		\ilGlobalPageTemplate	$a_tpl,
		string	$a_content
	)

protected

Write HTML to file.

Definition at line 159 of file class.NotesHtmlExport.php.

References ilGlobalPageTemplate\printToString(), and ilGlobalPageTemplate\setContent().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\exportPage().

      : string {
         $file = $this->target_dir . "/" . $a_file;
         if (is_file($file)) {
             return "";
         }
         $a_tpl->setContent($a_content);
         $content = $a_tpl->printToString();
 
         // open file
         file_put_contents($file, $content);
         return $file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zipPackage()

ILIAS\Notes\Export\NotesHtmlExport::zipPackage ( )

Definition at line 107 of file class.NotesHtmlExport.php.

References ilExport\_getExportDirectory(), ilFileUtils\delDir(), and ilFileUtils\zip().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\exportHTML().

                                 : string
     {
         $zip_file = \ilExport::_getExportDirectory($this->user_id, "html_notes", "usr") .
             "/user_notes.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

◆ $author_ids

array ILIAS\Notes\Export\NotesHtmlExport::$author_ids

protected

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

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct().

◆ $export_dir

string ILIAS\Notes\Export\NotesHtmlExport::$export_dir

protected

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

◆ $export_key_set

ILIAS\Notes\Export\NotesHtmlExport::$export_key_set = false

staticprotected

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

◆ $export_util

ILIAS components Export HTML Util ILIAS\Notes\Export\NotesHtmlExport::$export_util

protected

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

◆ $global_screen

ILIAS GlobalScreen Services ILIAS\Notes\Export\NotesHtmlExport::$global_screen

protected

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

◆ $lng

ilLanguage ILIAS\Notes\Export\NotesHtmlExport::$lng

protected

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

◆ $sub_dir

string ILIAS\Notes\Export\NotesHtmlExport::$sub_dir

protected

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

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct().

◆ $target_dir

string ILIAS\Notes\Export\NotesHtmlExport::$target_dir

protected

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

◆ $type

int ILIAS\Notes\Export\NotesHtmlExport::$type

protected

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

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct().

◆ $user_id

int ILIAS\Notes\Export\NotesHtmlExport::$user_id

protected

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

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct().

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

components/ILIAS/Notes/Export/class.NotesHtmlExport.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ exportHTML()

◆ exportPage()

◆ exportUserImages()

◆ getInitialisedTemplate()

◆ initDirectories()

◆ writeExportFile()

◆ zipPackage()

Field Documentation

◆ $author_ids

◆ $export_dir

◆ $export_key_set

◆ $export_util

◆ $global_screen

◆ $lng

◆ $sub_dir

◆ $target_dir

◆ $type

◆ $user_id