ILIAS\Help\Module\ModuleManager Class Reference

Collaboration diagram for ILIAS\Help\Module\ModuleManager:

Public Member Functions
	__construct (ModuleDBRepository $repo, InternalDomainService $domain)
	upload (array $file)
	getHelpModules ()
	getActiveModules ()
	isHelpActive ()
	areTooltipsActive ()
	isAuthoringMode ()
	getAuthoringLMId ()
	lookupModuleTitle (int $id)
	lookupModuleLmId (int $id)
	activate (int $module_id)
	deactivate (int $module_id)
	deleteModule (int $id)
	isHelpLM (int $lm_id)
	saveOrder (array $order)

Protected Attributes
ilObjUser	$user
ILIAS Help Tooltips TooltipsManager	$tooltips
ILIAS Help Map MapManager	$help_map
ilAppEventHandler	$event
ModuleDBRepository	$repo
ilSetting	$settings

Detailed Description

Definition at line 26 of file ModuleManager.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Help\Module\ModuleManager::__construct	(	ModuleDBRepository	$repo,
		InternalDomainService	$domain
	)

Definition at line 35 of file ModuleManager.php.

References ILIAS\Help\Module\ModuleManager\$repo, ILIAS\Help\InternalDomainService\map(), ILIAS\Repository\settings(), ILIAS\Help\InternalDomainService\tooltips(), and ILIAS\Repository\user().

      {
        $this->repo = $repo;
        $this->settings = $domain->settings();
        $this->help_map = $domain->map();
        $this->tooltips = $domain->tooltips();
        $this->event = $domain->event();
        $this->user = $domain->user();
    }

Here is the call graph for this function:

Member Function Documentation

activate()

ILIAS\Help\Module\ModuleManager::activate

(

int

$module_id

)

Definition at line 136 of file ModuleManager.php.

                                            : void
    {
        $this->repo->writeActive($module_id, true);
    }

areTooltipsActive()

ILIAS\Help\Module\ModuleManager::areTooltipsActive

(

)

Definition at line 103 of file ModuleManager.php.

References ILIAS\Help\Module\ModuleManager\isHelpActive(), and ILIAS\Repository\settings().

                                       : bool
    {
        if ($this->settings->get("help_mode") === "1") {
            return false;
        }
        return $this->isHelpActive();
    }

Here is the call graph for this function:

deactivate()

ILIAS\Help\Module\ModuleManager::deactivate

(

int

$module_id

)

Definition at line 141 of file ModuleManager.php.

                                              : void
    {
        $this->repo->writeActive($module_id, false);
    }

deleteModule()

ILIAS\Help\Module\ModuleManager::deleteModule

(

int

$id

)

Definition at line 146 of file ModuleManager.php.

References ilObject\_lookupType().

     : void {
        $lm_id = $this->repo->lookupModuleLmId($id);

        // delete learning module
        if (\ilObject::_lookupType($lm_id) === "lm") {
            $lm = new \ilObjLearningModule($lm_id, false);
            $lm->delete();
        }

        // delete mappings
        $this->help_map->deleteEntriesOfModule($id);

        // delete tooltips
        $this->tooltips->deleteTooltipsOfModule($id);

        $this->repo->deleteModule($id);
    }

Here is the call graph for this function:

getActiveModules()

ILIAS\Help\Module\ModuleManager::getActiveModules

(

)

Returns

int[]

Definition at line 81 of file ModuleManager.php.

References ILIAS\Help\Module\ModuleManager\getHelpModules(), and ILIAS\Repository\int().

Referenced by ILIAS\Help\Module\ModuleManager\isHelpActive().

                                      : array
    {
        $ids = [];
        foreach ($this->getHelpModules() as $m) {
            if ($m["active"]) {
                $ids[] = (int) $m["id"];
            }
        }
        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAuthoringLMId()

ILIAS\Help\Module\ModuleManager::getAuthoringLMId

(

)

Definition at line 115 of file ModuleManager.php.

References ilObject\_lookupObjId().

Referenced by ILIAS\Help\Module\ModuleManager\isAuthoringMode().

                                      : int
    {
        $lm_id = 0;
        if (defined('OH_REF_ID') && (int) OH_REF_ID > 0) {
            $lm_id = \ilObject::_lookupObjId((int) OH_REF_ID);
        }
        return $lm_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHelpModules()

ILIAS\Help\Module\ModuleManager::getHelpModules

(

)

Definition at line 73 of file ModuleManager.php.

Referenced by ILIAS\Help\Module\ModuleManager\getActiveModules().

                                    : array
    {
        return $this->repo->getHelpModules();
    }

Here is the caller graph for this function:

isAuthoringMode()

ILIAS\Help\Module\ModuleManager::isAuthoringMode

(

)

Definition at line 111 of file ModuleManager.php.

References ILIAS\Help\Module\ModuleManager\getAuthoringLMId().

Referenced by ILIAS\Help\Module\ModuleManager\isHelpActive().

                                     : bool
    {
        return ($this->getAuthoringLMId() > 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isHelpActive()

ILIAS\Help\Module\ModuleManager::isHelpActive

(

)

Definition at line 92 of file ModuleManager.php.

References ILIAS\Help\Module\ModuleManager\getActiveModules(), ILIAS\Help\Module\ModuleManager\isAuthoringMode(), and ILIAS\Repository\user().

Referenced by ILIAS\Help\Module\ModuleManager\areTooltipsActive().

                                  : bool
    {
        if ($this->user->getLanguage() !== "de") {
            return false;
        }
        if ($this->isAuthoringMode()) {
            return true;
        }
        return (count($this->getActiveModules()) > 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isHelpLM()

ILIAS\Help\Module\ModuleManager::isHelpLM

(

int

$lm_id

)

Definition at line 166 of file ModuleManager.php.

     : bool {
        return $this->repo->isHelpLM($lm_id);
    }

lookupModuleLmId()

ILIAS\Help\Module\ModuleManager::lookupModuleLmId

(

int

$id

)

Definition at line 130 of file ModuleManager.php.

     : int {
        return $this->repo->lookupModuleLmId($id);
    }

lookupModuleTitle()

ILIAS\Help\Module\ModuleManager::lookupModuleTitle

(

int

$id

)

Definition at line 124 of file ModuleManager.php.

     : string {
        return $this->repo->lookupModuleTitle($id);
    }

saveOrder()

ILIAS\Help\Module\ModuleManager::saveOrder

(

array

$order

)

Definition at line 172 of file ModuleManager.php.

                                           : void
    {
        $this->repo->saveOrder($order);
    }

upload()

ILIAS\Help\Module\ModuleManager::upload

(

array

$file

)

Definition at line 47 of file ModuleManager.php.

References Vendor\Package\$e, $id, and null.

     : void {
        $id = $this->repo->create();

        try {
            $imp = new \ilImport();
            $conf = $imp->getConfig("components/ILIAS/Help");
            $conf->setModuleId($id);
            $new_id = $imp->importObject(null, $file["tmp_name"], $file["name"], "lm", "components/ILIAS/LearningModule"); //
            $newObj = new \ilObjLearningModule($new_id, false);

            $this->repo->writeHelpModuleLmId($id, $newObj->getId());
        } catch (\ilManifestFileNotFoundImportException $e) {
            throw new \ilLMOldExportFileException("This file seems to be from ILIAS version 5.0.x or lower. Import is not supported anymore.");
        }

        $this->event->raise(
            'components/ILIAS/Help',
            'create',
            array(
                'obj_id' => $id,
                'obj_type' => 'lm'
            )
        );
    }

Field Documentation

$event

ilAppEventHandler ILIAS\Help\Module\ModuleManager::$event

protected

Definition at line 31 of file ModuleManager.php.

$help_map

ILIAS Help Map MapManager ILIAS\Help\Module\ModuleManager::$help_map

protected

Definition at line 30 of file ModuleManager.php.

$repo

ModuleDBRepository ILIAS\Help\Module\ModuleManager::$repo

protected

Definition at line 32 of file ModuleManager.php.

Referenced by ILIAS\Help\Module\ModuleManager\__construct().

$settings

ilSetting ILIAS\Help\Module\ModuleManager::$settings

protected

Definition at line 33 of file ModuleManager.php.

$tooltips

ILIAS Help Tooltips TooltipsManager ILIAS\Help\Module\ModuleManager::$tooltips

protected

Definition at line 29 of file ModuleManager.php.

$user

ilObjUser ILIAS\Help\Module\ModuleManager::$user

protected

Definition at line 28 of file ModuleManager.php.

---

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

• components/ILIAS/Help/Module/ModuleManager.php