ilHelpMapping Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilHelpMapping:

Public Member Functions
	__construct ()

Static Public Member Functions
static	saveScreenIdsForChapter (int $a_chap, array $a_ids)
static	saveMappingEntry (int $a_chap, string $a_comp, string $a_screen_id, string $a_screen_sub_id, string $a_perm, int $a_module_id=0)
static	removeScreenIdsOfChapter (int $a_chap, int $a_module_id=0)
static	getScreenIdsOfChapter (int $a_chap, int $a_module_id=0)
static	getHelpSectionsForId (string $a_screen_id, int $a_ref_id)
static	hasScreenIdSections (string $a_screen_id)
	Has given screen Id any sections? Note: We removed the "ref_id" parameter here, since this method should be fast. More...
static	deleteEntriesOfModule (int $a_id)

Protected Attributes
ilDBInterface	$db

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Help mapping

Author

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

Definition at line 23 of file class.ilHelpMapping.php.

Constructor & Destructor Documentation

__construct()

ilHelpMapping::__construct

(

)

Definition at line 27 of file class.ilHelpMapping.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
    }

References $DIC.

Member Function Documentation

deleteEntriesOfModule()

static ilHelpMapping::deleteEntriesOfModule ( int  $a_id )

static

Definition at line 287 of file class.ilHelpMapping.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate("DELETE FROM help_map WHERE " .
            " module_id = " . $ilDB->quote($a_id, "integer"));
    }

getHelpSectionsForId()

static ilHelpMapping::getHelpSectionsForId ( string  $a_screen_id, int  $a_ref_id  )

static

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilAccess = $DIC->access();
        $ilSetting = $DIC->settings();
        $rbacreview = $DIC->rbac()->review();
        $ilUser = $DIC->user();
        $ilObjDataCache = $DIC["ilObjDataCache"];
 
        if (defined('OH_REF_ID') && (int) OH_REF_ID > 0) {
            $module = 0;
        } else {
            $module = (int) $ilSetting->get("help_module");
            if ($module === 0) {
                return array();
            }
        }
 
        $sc_id = explode("/", $a_screen_id);
        $chaps = array();
        if ($sc_id[0] != "") {
            if ($sc_id[1] == "") {
                $sc_id[1] = "-";
            }
            if ($sc_id[2] == "") {
                $sc_id[2] = "-";
            }
            $set = $ilDB->query(
                "SELECT chap, perm FROM help_map JOIN lm_tree" .
                " ON (help_map.chap = lm_tree.child) " .
                " WHERE (component = " . $ilDB->quote($sc_id[0], "text") .
                " OR component = " . $ilDB->quote("*", "text") . ")" .
                " AND screen_id = " . $ilDB->quote($sc_id[1], "text") .
                " AND screen_sub_id = " . $ilDB->quote($sc_id[2], "text") .
                " AND module_id = " . $ilDB->quote($module, "integer") .
                " ORDER BY lm_tree.lft"
            );
            while ($rec = $ilDB->fetchAssoc($set)) {
                if ($rec["perm"] != "" && $rec["perm"] != "-") {
                    // check special "create*" permission
                    if ($rec["perm"] === "create*") {
                        $has_create_perm = false;
 
                        // check owner
                        if ($ilUser->getId() === $ilObjDataCache->lookupOwner(ilObject::_lookupObjId($a_ref_id))) {
                            $has_create_perm = true;
                        } elseif ($rbacreview->isAssigned($ilUser->getId(), SYSTEM_ROLE_ID)) { // check admin
                            $has_create_perm = true;
                        } elseif ($ilAccess->checkAccess("read", "", $a_ref_id)) {
                            $perm = $rbacreview->getUserPermissionsOnObject($ilUser->getId(), $a_ref_id);
                            foreach ($perm as $p) {
                                if (strpos($p, "create_") === 0) {
                                    $has_create_perm = true;
                                }
                            }
                        }
                        if ($has_create_perm) {
                            $chaps[] = $rec["chap"];
                        }
                    } elseif ($ilAccess->checkAccess($rec["perm"], "", $a_ref_id)) {
                        $chaps[] = $rec["chap"];
                    }
                } else {
                    $chaps[] = $rec["chap"];
                }
            }
        }
        return $chaps;
    }

Referenced by ilHelpGUI\getHelpSections(), and ilHelpGUI\showHelp().

Here is the caller graph for this function:

getScreenIdsOfChapter()

static ilHelpMapping::getScreenIdsOfChapter ( int  $a_chap, int  $a_module_id = 0  )

static

Definition at line 112 of file class.ilHelpMapping.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query(
            "SELECT * FROM help_map " .
            " WHERE chap = " . $ilDB->quote($a_chap, "integer") .
            " AND module_id = " . $ilDB->quote($a_module_id, "integer") .
            " ORDER BY component, screen_id, screen_sub_id"
        );
        $screen_ids = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            if ($rec["screen_id"] == "-") {
                $rec["screen_id"] = "";
            }
            if ($rec["screen_sub_id"] == "-") {
                $rec["screen_sub_id"] = "";
            }
            $id = $rec["component"] . "/" . $rec["screen_id"] . "/" . $rec["screen_sub_id"];
            if ($rec["perm"] != "" && $rec["perm"] != "-") {
                $id .= "#" . $rec["perm"];
            }
            $screen_ids[] = $id;
        }
        return $screen_ids;
    }

Referenced by ilHelpMappingTableGUI\fillRow().

Here is the caller graph for this function:

hasScreenIdSections()

static ilHelpMapping::hasScreenIdSections ( string  $a_screen_id )

static

Has given screen Id any sections? Note: We removed the "ref_id" parameter here, since this method should be fast.

It is used to decide whether the help button should appear or not. We assume that there is at least one section for users with the "read" permission.

Definition at line 224 of file class.ilHelpMapping.php.

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
 
        if ($ilUser->getLanguage() !== "de") {
            return false;
        }
 
        if ($ilSetting->get("help_mode") === "2") {
            return false;
        }
 
        if (defined('OH_REF_ID') && (int) OH_REF_ID > 0) {
            $module = 0;
        } else {
            $module = (int) $ilSetting->get("help_module");
            if ($module === 0) {
                return false;
            }
        }
 
        $sc_id = explode("/", $a_screen_id);
        if ($sc_id[0] != "") {
            if ($sc_id[1] == "") {
                $sc_id[1] = "-";
            }
            if ($sc_id[2] == "") {
                $sc_id[2] = "-";
            }
            $set = $ilDB->query(
                "SELECT chap, perm FROM help_map " .
                " WHERE (component = " . $ilDB->quote($sc_id[0], "text") .
                " OR component = " . $ilDB->quote("*", "text") . ")" .
                " AND screen_id = " . $ilDB->quote($sc_id[1], "text") .
                " AND screen_sub_id = " . $ilDB->quote($sc_id[2], "text") .
                " AND module_id = " . $ilDB->quote($module, "integer")
            );
            while ($rec = $ilDB->fetchAssoc($set)) {
                return true;
 
                // no permission check, since it takes to much performance
                // getHelpSectionsForId() does the permission checks.
                /*if ($rec["perm"] != "" && $rec["perm"] != "-")
                {
                    if ($ilAccess->checkAccess($rec["perm"], "", (int) $a_ref_id))
                    {
                        return true;
                    }
                }
                else
                {
                    return true;
                }*/
            }
        }
        return false;
    }

Referenced by ilHelpGUI\hasSections().

Here is the caller graph for this function:

removeScreenIdsOfChapter()

static ilHelpMapping::removeScreenIdsOfChapter ( int  $a_chap, int  $a_module_id = 0  )

static

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(
            "DELETE FROM help_map WHERE " .
            " chap = " . $ilDB->quote($a_chap, "integer") .
            " AND module_id = " . $ilDB->quote($a_module_id, "integer")
        );
    }

Referenced by ilStructureObject\delete().

Here is the caller graph for this function:

saveMappingEntry()

static ilHelpMapping::saveMappingEntry ( int  $a_chap, string  $a_comp, string  $a_screen_id, string  $a_screen_sub_id, string  $a_perm, int  $a_module_id = 0  )

static

Definition at line 72 of file class.ilHelpMapping.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->replace(
            "help_map",
            array("chap" => array("integer", $a_chap),
                "component" => array("text", $a_comp),
                "screen_id" => array("text", $a_screen_id),
                "screen_sub_id" => array("text", $a_screen_sub_id),
                "perm" => array("text", $a_perm),
                "module_id" => array("integer", $a_module_id)
                ),
            array()
        );
    }

Referenced by ilHelpDataSet\importRecord().

Here is the caller graph for this function:

saveScreenIdsForChapter()

static ilHelpMapping::saveScreenIdsForChapter ( int  $a_chap, array  $a_ids  )

static

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        self::removeScreenIdsOfChapter($a_chap);
        foreach ($a_ids as $id) {
            $id = trim($id);
            $id = explode("/", $id);
            if ($id[0] != "") {
                if (($id[1] ?? "") ==  "") {
                    $id[1] = "-";
                }
                $id2 = explode("#", ($id[2] ?? ""));
                if ($id2[0] == "") {
                    $id2[0] = "-";
                }
                if (($id2[1] ?? "") == "") {
                    $id2[1] = "-";
                }
                $ilDB->replace(
                    "help_map",
                    array("chap" => array("integer", $a_chap),
                        "component" => array("text", $id[0]),
                        "screen_id" => array("text", $id[1]),
                        "screen_sub_id" => array("text", $id2[0]),
                        "perm" => array("text", $id2[1]),
                        "module_id" => array("integer", 0)
                        ),
                    array()
                );
            }
        }
    }

Referenced by ilObjContentObjectGUI\saveHelpMapping().

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilHelpMapping::$db

protected

Definition at line 25 of file class.ilHelpMapping.php.

---

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

• Services/Help/classes/class.ilHelpMapping.php