ilLMPresentationStatus Class Reference

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

Collaboration diagram for ilLMPresentationStatus:

Public Member Functions
	__construct (ilObjUser $user, ilObjLearningModule $lm, ilLMTree $lm_tree, string $requested_transl="", string $requested_focus_id="", string $requested_focus_return="", string $requested_search_string="", string $offline, bool $export_all_languages, string $export_format)
	Constructor. More...
	getLang ()
	Get language key. More...
	getFocusId ()
	getFocusReturn ()
	getSearchString ()
	offline ()
	exportAllLanguages ()
	getExportFormat ()
	getLMPresentationTitle ()
	Get lm presentationtitle. More...
	isTocNecessary ()
	Is TOC necessary, see #30027 Check if at least two entries will be shown. More...

Protected Member Functions
	init ()
	Init. More...

Protected Attributes
	$lang
	$focus_id = null

Detailed Description

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

Author

@leifos.de

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

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

      {
        $this->lm = $lm;
        $this->ot = ilObjectTranslation::getInstance($lm->getId());
        $this->requested_transl = (string) $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->init();
    }

References ilObject\getId(), ilObjectTranslation\getInstance(), init(), offline(), and user().

Here is the call graph for this function:

Member Function Documentation

exportAllLanguages()

ilLMPresentationStatus::exportAllLanguages

(

)

Returns

bool

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

                                         : bool
    {
        return $this->export_all_languages;
    }

getExportFormat()

ilLMPresentationStatus::getExportFormat

(

)

Returns

bool

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

                                      : bool
    {
        return $this->export_format;
    }

getFocusId()

ilLMPresentationStatus::getFocusId

(

)

Returns

int

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

    {
        return $this->focus_id;
    }

References $focus_id.

getFocusReturn()

ilLMPresentationStatus::getFocusReturn

(

)

Returns

int

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

    {
        return $this->requested_focus_return;
    }

getLang()

ilLMPresentationStatus::getLang

(

)

Get language key.

Returns

string

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

                              : string
    {
        return $this->lang;
    }

References $lang.

getLMPresentationTitle()

ilLMPresentationStatus::getLMPresentationTitle

(

)

Get lm presentationtitle.

Returns

string

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

    {
        if ($this->offline() && $this->lang != "" && $this->lang != "-") {
            $ot = $this->ot;
            $data = $ot->getLanguages();
            $ltitle = $data[$this->lang]["title"];
            if ($ltitle != "") {
                return $ltitle;
            }
        }
        return $this->lm->getTitle();
    }

References $data, $lang, and offline().

Here is the call graph for this function:

getSearchString()

ilLMPresentationStatus::getSearchString

(

)

Returns

int

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

    {
        return $this->requested_search_string;
    }

init()

ilLMPresentationStatus::init ( )

protected

Init.

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

    {
        // determine language
        $this->lang = "-";
        if ($this->ot->getContentActivated()) {
            $langs = $this->ot->getLanguages();
            if (isset($langs[$this->requested_transl]) || $this->requested_transl == $this->ot->getMasterLanguage()) {
                $this->lang = $this->requested_transl;
            } elseif (isset($langs[$this->user->getCurrentLanguage()])) {
                $this->lang = $this->user->getCurrentLanguage();
            }
            if ($this->lang == $this->ot->getMasterLanguage()) {
                $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;
        }
    }

References user().

Referenced by __construct().

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.

Returns

bool

Definition at line 158 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

(

)

Returns

bool

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

                              : bool
    {
        return $this->offline;
    }

Referenced by __construct(), and getLMPresentationTitle().

Here is the caller graph for this function:

Field Documentation

$focus_id

ilLMPresentationStatus::$focus_id = null

protected

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

Referenced by getFocusId().

$lang

ilLMPresentationStatus::$lang

protected

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

Referenced by getLang(), and getLMPresentationTitle().

---

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

• Modules/LearningModule/Presentation/classes/class.ilLMPresentationStatus.php