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)
	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: @leifos.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`
	)

Constructor.

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

      {
        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
        );
 
        $this->navigation_status = new ilLMNavigationStatus(
            $user,
            (int) $this->request->getRequestedObjId(),
            $this->lm_tree,
            $this->lm,
            $this->lm_set,
            $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
        );
    }

References $DIC, ilLMTracker\getInstance(), ilLMTree\getInstance(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ getLearningModule()

ilLMPresentationService::getLearningModule ( )

Returns: ilObjLearningModule

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

                                        : ilObjLearningModule
    {
        return $this->lm;
    }

References $lm.

◆ getLearningModuleGUI()

ilLMPresentationService::getLearningModuleGUI ( )

Returns: ilObjLearningModuleGUI

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

                                           : ilObjLearningModuleGUI
    {
        return $this->lm_gui;
    }

◆ getLinker()

ilLMPresentationService::getLinker ( )

Get linker.

Returns: ilLMPresentationLinker

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

    {
        return $this->linker;
    }

◆ getLMTree()

ilLMPresentationService::getLMTree ( )

Returns: ilLMTree

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

                                : ilLMTree
    {
        return $this->lm_tree;
    }

◆ getNavigationStatus()

ilLMPresentationService::getNavigationStatus ( )

Returns: ilLMNavigationStatus

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

                                          : ilLMNavigationStatus
    {
        return $this->navigation_status;
    }

◆ getPresentationStatus()

ilLMPresentationService::getPresentationStatus ( )

Returns: ilLMPresentationStatus

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

                                            : ilLMPresentationStatus
    {
        return $this->presentation_status;
    }

◆ getRequest()

ilLMPresentationService::getRequest ( )

Get request.

Returns: ilLMPresentationRequest

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

    {
        return $this->request;
    }

◆ getSettings()

ilLMPresentationService::getSettings ( )

Get learning module settings.

Returns: ilSetting

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

                                  : ilSetting
    {
        return $this->lm_set;
    }

References $lm_set.

◆ getTracker()

ilLMPresentationService::getTracker ( )

Get tracker.

Returns: ilLMTracker

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

    {
        return $this->tracker;
    }

References $tracker.

Field Documentation

◆ $lm

ilLMPresentationService::$lm

protected

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

Referenced by getLearningModule().

◆ $tracker

ilLMPresentationService::$tracker