Contains info on offline mode, focus, translation, etc. More...

Collaboration diagram for ilLMPresentationStatus:

Public Member Functions
	__construct (ilObjUser $user, ilObjLearningModule $lm, ilLMTree $lm_tree, Translations $ot, string $requested_transl="", string $requested_focus_id="", string $requested_focus_return="", string $requested_search_string="", bool $offline=false, bool $export_all_languages=false, string $export_format="", bool $embed_mode=false)

	getLang ()

	getConcreteLang ()
	Only difference to getLang(): if current language is the master lang the language key will be returned, not "-". More...

	getFocusId ()

	getFocusReturn ()

	getSearchString ()

	offline ()

	getEmbedMode ()

	exportAllLanguages ()

	getExportFormat ()

	getLMPresentationTitle ()

	isTocNecessary ()
	Is TOC necessary, see #30027 Check if at least two entries will be shown. More...

Data Fields
bool	$offline

Protected Member Functions
	init ()

Protected Attributes
string	$export_format

bool	$export_all_languages

ilObjUser	$user

string	$requested_search_string

ilLMTree	$lm_tree

string	$requested_focus_return

string	$requested_focus_id

string	$requested_transl

Translations	$ot

ilObjLearningModule	$lm

string	$lang

int	$focus_id = 0

	$concrete_lang = ""

	$embed_mode = false

Detailed Description

Contains info on offline mode, focus, translation, etc.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLMPresentationStatus::__construct	(	ilObjUser	$user,
		ilObjLearningModule	$lm,
		ilLMTree	$lm_tree,
		Translations	$ot,
		string	$requested_transl = `""`,
		string	$requested_focus_id = `""`,
		string	$requested_focus_return = `""`,
		string	$requested_search_string = `""`,
		bool	$offline = `false`,
		bool	$export_all_languages = `false`,
		string	$export_format = `""`,
		bool	$embed_mode = `false`
	)

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

References $embed_mode, $export_all_languages, $export_format, $lm, $lm_tree, $offline, $ot, $requested_focus_id, $requested_focus_return, $requested_search_string, $requested_transl, $user, init(), offline(), and ILIAS\Repository\user().

       {
         $this->lm = $lm;
         $this->ot = $ot;
         $this->requested_transl = $requested_transl;
         $this->requested_focus_id = $requested_focus_id;
         $this->requested_focus_return = $requested_focus_return;
         $this->requested_search_string = $requested_search_string;
         $this->user = $user;
         $this->lm_tree = $lm_tree;
         $this->offline = $offline;
         $this->export_all_languages = $export_all_languages;
         $this->export_format = $export_format;
         $this->embed_mode = $embed_mode;
         $this->init();
     }

Here is the call graph for this function:

Member Function Documentation

◆ exportAllLanguages()

ilLMPresentationStatus::exportAllLanguages ( )

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

References $export_all_languages.

                                         : bool
     {
         return $this->export_all_languages;
     }

◆ getConcreteLang()

ilLMPresentationStatus::getConcreteLang ( )

Only difference to getLang(): if current language is the master lang the language key will be returned, not "-".

Definition at line 106 of file class.ilLMPresentationStatus.php.

References $concrete_lang.

                                      : string
     {
         return $this->concrete_lang;
     }

◆ getEmbedMode()

ilLMPresentationStatus::getEmbedMode ( )

Definition at line 131 of file class.ilLMPresentationStatus.php.

References $embed_mode.

                                   : bool
     {
         return $this->embed_mode;
     }

◆ getExportFormat()

ilLMPresentationStatus::getExportFormat ( )

Definition at line 141 of file class.ilLMPresentationStatus.php.

References $export_format.

                                      : string
     {
         return $this->export_format;
     }

◆ getFocusId()

ilLMPresentationStatus::getFocusId ( )

Definition at line 111 of file class.ilLMPresentationStatus.php.

References $focus_id.

                                 : int
     {
         return $this->focus_id;
     }

◆ getFocusReturn()

ilLMPresentationStatus::getFocusReturn ( )

Definition at line 116 of file class.ilLMPresentationStatus.php.

References $requested_focus_return.

                                     : string
     {
         return $this->requested_focus_return;
     }

◆ getLang()

ilLMPresentationStatus::getLang ( )

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

References $lang.

                              : string
     {
         return $this->lang;
     }

◆ getLMPresentationTitle()

ilLMPresentationStatus::getLMPresentationTitle ( )

Definition at line 146 of file class.ilLMPresentationStatus.php.

References $data, $lang, $ot, ILIAS\ILIASObject\Properties\Translations\Translations\getDefaultLanguage(), and ILIAS\ILIASObject\Properties\Translations\Translations\getLanguages().

                                             : string
     {
         if ($this->lang != "" && $this->lang != "-") {
             $ltitle = "";
             $ot = $this->ot;
             $data = $ot->getLanguages();
             if (isset($data[$this->lang])) {
                 $ltitle = $data[$this->lang]->getTitle();
             }
             if ($ltitle !== "") {
                 return $ltitle;
             }
             $fb = $ot->getDefaultLanguage();
             if (isset($data[$fb])) {
                 $ltitle = $data[$fb]->getTitle();
             }
             if ($ltitle !== "") {
                 return $ltitle;
             }
         }
         return $this->lm->getTitle();
     }

Here is the call graph for this function:

◆ getSearchString()

ilLMPresentationStatus::getSearchString ( )

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

References $requested_search_string.

                                      : string
     {
         return $this->requested_search_string;
     }

◆ init()

ilLMPresentationStatus::init ( )

protected

Definition at line 73 of file class.ilLMPresentationStatus.php.

References $lang, $requested_focus_id, $requested_transl, and ILIAS\Repository\user().

Referenced by __construct().

                              : void
     {
         // determine language
         $this->lang = "-";
         $this->concrete_lang = "-";
         if ($this->ot->getContentTranslationActivated()) {
             $langs = $this->ot->getLanguages();
             if (isset($langs[$this->requested_transl]) || $this->requested_transl == $this->ot->getBaseLanguage()) {
                 $this->lang = $this->requested_transl;
             } else {
                 $this->lang = $this->user->getCurrentLanguage();
             }
             $this->concrete_lang = $this->lang;
             if ($this->lang == $this->ot->getBaseLanguage()) {
                 $this->lang = "-";
             }
         }
 
         // determin focus id
         if ($this->requested_focus_id > 0 && $this->lm_tree->isInTree($this->requested_focus_id)) {
             $this->focus_id = $this->requested_focus_id;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTocNecessary()

ilLMPresentationStatus::isTocNecessary ( )

Is TOC necessary, see #30027 Check if at least two entries will be shown.

Definition at line 173 of file class.ilLMPresentationStatus.php.

                                     : bool
     {
         $childs = $this->lm_tree->getChilds($this->lm_tree->getRootId());
         if (count($childs) == 0) {      // no chapter -> false
             return false;
         }
         if (count($childs) > 1) {       // more than one chapter -> true
             return true;
         }
         if ($this->lm->getTOCMode() != "pages") {   // one chapter TOC does not show pages -> false
             return false;
         }
         $current_chapter = current($childs);
         $childs = $this->lm_tree->getChilds($current_chapter["child"]);
         if (count($childs) > 1) {
             return true;            // more than one page -> true
         }
         return false;               // zero or one page -> false
     }

◆ offline()

ilLMPresentationStatus::offline ( )

Definition at line 126 of file class.ilLMPresentationStatus.php.

References $offline.

Referenced by __construct().

                              : bool
     {
         return $this->offline;
     }

Here is the caller graph for this function:

Field Documentation

◆ $concrete_lang

ilLMPresentationStatus::$concrete_lang = ""

protected

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

Referenced by getConcreteLang().

◆ $embed_mode

ilLMPresentationStatus::$embed_mode = false

protected

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

Referenced by __construct(), and getEmbedMode().

◆ $export_all_languages

bool ilLMPresentationStatus::$export_all_languages

protected

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

Referenced by __construct(), and exportAllLanguages().

◆ $export_format

string ilLMPresentationStatus::$export_format

protected

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

Referenced by __construct(), and getExportFormat().

◆ $focus_id

int ilLMPresentationStatus::$focus_id = 0

protected

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

Referenced by getFocusId().

◆ $lang

string ilLMPresentationStatus::$lang

protected

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

Referenced by getLang(), getLMPresentationTitle(), and init().

◆ $lm

ilObjLearningModule ilLMPresentationStatus::$lm

protected

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

Referenced by __construct().

◆ $lm_tree

ilLMTree ilLMPresentationStatus::$lm_tree

protected

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

Referenced by __construct().

◆ $offline

bool ilLMPresentationStatus::$offline

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

Referenced by __construct(), and offline().

◆ $ot

Translations ilLMPresentationStatus::$ot

protected

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

Referenced by __construct(), and getLMPresentationTitle().

◆ $requested_focus_id

string ilLMPresentationStatus::$requested_focus_id

protected

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

Referenced by __construct(), and init().

◆ $requested_focus_return

string ilLMPresentationStatus::$requested_focus_return

protected

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

Referenced by __construct(), and getFocusReturn().

◆ $requested_search_string

string ilLMPresentationStatus::$requested_search_string

protected

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

Referenced by __construct(), and getSearchString().

◆ $requested_transl

string ilLMPresentationStatus::$requested_transl

protected

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

Referenced by __construct(), and init().

◆ $user

ilObjUser ilLMPresentationStatus::$user

protected

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

Referenced by __construct().

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

components/ILIAS/LearningModule/Presentation/class.ilLMPresentationStatus.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ exportAllLanguages()

◆ getConcreteLang()

◆ getEmbedMode()

◆ getExportFormat()

◆ getFocusId()

◆ getFocusReturn()

◆ getLang()

◆ getLMPresentationTitle()

◆ getSearchString()

◆ init()

◆ isTocNecessary()

◆ offline()

Field Documentation

◆ $concrete_lang

◆ $embed_mode

◆ $export_all_languages

◆ $export_format

◆ $focus_id

◆ $lang

◆ $lm

◆ $lm_tree

◆ $offline

◆ $ot

◆ $requested_focus_id

◆ $requested_focus_return

◆ $requested_search_string

◆ $requested_transl

◆ $user