ilLMPresentationService Class Reference

Main service init and factory. More...

Collaboration diagram for ilLMPresentationService:

Public Member Functions
	__construct (ilObjUser $user, array $query_params, bool $offline=false, bool $export_all_languages=false, string $export_format="", ilCtrl $ctrl=null, bool $embed_mode=false)
	Constructor. More...
	getSettings ()
	Get learning module settings. More...
	getLearningModuleGUI ()
	getLearningModule ()
	getLMTree ()
	getPresentationStatus ()
	getNavigationStatus ()
	getTracker ()
	Get tracker. More...
	getRequest ()
	Get request. More...
	getLinker ()
	Get linker. More...

Protected Attributes
	$lm
	$tracker

Detailed Description

Main service init and factory.

Author

.de

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

Constructor & Destructor Documentation

__construct()

ilLMPresentationService::__construct	(	ilObjUser	$user,
		array	$query_params,
		bool	$offline = false,
		bool	$export_all_languages = false,
		string	$export_format = "",
		ilCtrl	$ctrl = null,
		bool	$embed_mode = false
	)

Constructor.

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

References $DIC, $lm, $lm_set, ilLMTree\getInstance(), ilLMTracker\getInstance(), ilLMPresentationStatus\getLang(), and user().

      {
        global $DIC;

        $ctrl = (is_null($ctrl))
            ? $DIC->ctrl()
            : $ctrl;

        $this->request = new ilLMPresentationRequest($query_params);
        $this->user = $user;
        $this->ref_id = $this->request->getRequestedRefId();
        $this->lm_set = new ilSetting("lm");
        $this->lm_gui = new ilObjLearningModuleGUI([], $this->ref_id, true, false);
        $this->lm = $this->lm_gui->object;
        $this->lm_tree = ilLMTree::getInstance($this->lm->getId());
        $this->presentation_status = new ilLMPresentationStatus(
            $user,
            $this->lm,
            $this->lm_tree,
            $this->request->getRequestedTranslation(),
            $this->request->getRequestedFocusId(),
            $this->request->getRequestedFocusReturn(),
            (string) $this->request->getRequestedSearchString(),
            $offline,
            $export_all_languages,
            $export_format,
            $embed_mode
        );

        $this->navigation_status = new ilLMNavigationStatus(
            $user,
            (int) $this->request->getRequestedObjId(),
            $this->lm_tree,
            $this->lm,
            $this->lm_set,
            $this->request->getRequestedBackPage(),
            $this->request->getRequestedCmd(),
            (int) $this->request->getRequestedFocusId()
        );

        $this->tracker = ilLMTracker::getInstance($this->lm->getRefId());
        $this->tracker->setCurrentPage($this->navigation_status->getCurrentPage());

        $this->linker = new ilLMPresentationLinker(
            $this->lm,
            $this->lm_tree,
            $this->navigation_status->getCurrentPage(),
            $this->request->getRequestedRefId(),
            $this->presentation_status->getLang(),
            $this->request->getRequestedBackPage(),
            $this->request->getRequestedFromPage(),
            $this->presentation_status->offline(),
            $this->presentation_status->getExportFormat(),
            $this->presentation_status->exportAllLanguages(),
            $ctrl,
            $embed_mode
        );
    }

Here is the call graph for this function:

Member Function Documentation

getLearningModule()

ilLMPresentationService::getLearningModule

(

)

Returns

ilObjLearningModule

Definition at line 113 of file class.ilLMPresentationService.php.

References $lm.

Referenced by ILIAS\LearningModule\Menu\ilLMMenuGUI\__construct(), ilLMTOCExplorerGUI\__construct(), ilLMNavigationRendererGUI\__construct(), ilLMContentRendererGUI\__construct(), and ilLMTOCExplorerGUIFactory\getExplorer().

                                        : ilObjLearningModule
    {
        return $this->lm;
    }

Here is the caller graph for this function:

getLearningModuleGUI()

ilLMPresentationService::getLearningModuleGUI

(

)

Returns

ilObjLearningModuleGUI

Definition at line 105 of file class.ilLMPresentationService.php.

                                           : ilObjLearningModuleGUI
    {
        return $this->lm_gui;
    }

getLinker()

ilLMPresentationService::getLinker

(

)

Get linker.

Returns

ilLMPresentationLinker

Definition at line 167 of file class.ilLMPresentationService.php.

Referenced by ilLMTOCExplorerGUI\__construct(), ilLMNavigationRendererGUI\__construct(), and ilLMContentRendererGUI\__construct().

    {
        return $this->linker;
    }

Here is the caller graph for this function:

getLMTree()

ilLMPresentationService::getLMTree

(

)

Returns

ilLMTree

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

Referenced by ilLMNavigationRendererGUI\__construct(), ilLMContentRendererGUI\__construct(), and ilLMTOCExplorerGUIFactory\getExplorer().

                                : ilLMTree
    {
        return $this->lm_tree;
    }

Here is the caller graph for this function:

getNavigationStatus()

ilLMPresentationService::getNavigationStatus

(

)

Returns

ilLMNavigationStatus

Definition at line 137 of file class.ilLMPresentationService.php.

Referenced by ilLMNavigationRendererGUI\__construct(), ilLMContentRendererGUI\__construct(), and ilLMTOCExplorerGUIFactory\getExplorer().

                                          : ilLMNavigationStatus
    {
        return $this->navigation_status;
    }

Here is the caller graph for this function:

getPresentationStatus()

ilLMPresentationService::getPresentationStatus

(

)

Returns

ilLMPresentationStatus

Definition at line 129 of file class.ilLMPresentationService.php.

Referenced by ILIAS\LearningModule\Menu\ilLMMenuGUI\__construct(), ilLMNavigationRendererGUI\__construct(), ilLMContentRendererGUI\__construct(), and ilLMTOCExplorerGUIFactory\getExplorer().

                                            : ilLMPresentationStatus
    {
        return $this->presentation_status;
    }

Here is the caller graph for this function:

getRequest()

ilLMPresentationService::getRequest

(

)

Get request.

Returns

ilLMPresentationRequest

Definition at line 157 of file class.ilLMPresentationService.php.

Referenced by ilLMTOCExplorerGUIFactory\getExplorer().

    {
        return $this->request;
    }

Here is the caller graph for this function:

getSettings()

ilLMPresentationService::getSettings

(

)

Get learning module settings.

Returns

ilSetting

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

References $lm_set.

Referenced by ilLMNavigationRendererGUI\__construct(), and ilLMContentRendererGUI\__construct().

                                  : ilSetting
    {
        return $this->lm_set;
    }

Here is the caller graph for this function:

getTracker()

ilLMPresentationService::getTracker

(

)

Get tracker.

Returns

ilLMTracker

Definition at line 147 of file class.ilLMPresentationService.php.

References $tracker.

Referenced by ilLMTOCExplorerGUI\__construct(), ilLMNavigationRendererGUI\__construct(), ilLMContentRendererGUI\__construct(), and ilLMTOCExplorerGUIFactory\getExplorer().

    {
        return $this->tracker;
    }

Here is the caller graph for this function:

Field Documentation

$lm

ilLMPresentationService::$lm

protected

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

Referenced by __construct(), and getLearningModule().

$tracker

ilLMPresentationService::$tracker

protected

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

Referenced by getTracker().

---

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

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