ilHelpMapping Class Reference

Help mapping. More...

Collaboration diagram for ilHelpMapping:

Public Member Functions
	__construct ()
	Constructor. More...

Static Public Member Functions
static	saveScreenIdsForChapter ($a_chap, $a_ids)
	Save screen ids for chapter. More...
static	saveMappingEntry ( $a_chap, $a_comp, $a_screen_id, $a_screen_sub_id, $a_perm, $a_module_id=0)
	Save mapping entry. More...
static	removeScreenIdsOfChapter ($a_chap, $a_module_id=0)
	Remove screen ids of chapter. More...
static	getScreenIdsOfChapter ($a_chap, $a_module_id=0)
	Get screen ids of chapter. More...
static	getHelpSectionsForId ($a_screen_id, $a_ref_id)
	Get help sections for screen id. More...
static	hasScreenIdSections ($a_screen_id)
	Has given screen Id any sections? More...
static	deleteEntriesOfModule ($a_id)
	Delete entries of module. More...

Protected Attributes
	$db

Detailed Description

Help mapping.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilHelpMapping::__construct

(

)

Constructor.

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

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

References $DIC.

Member Function Documentation

deleteEntriesOfModule()

static ilHelpMapping::deleteEntriesOfModule (   $a_id )

static

Delete entries of module.

Parameters

return

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

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

References $DIC, and $ilDB.

Referenced by ilObjHelpSettings\deleteModule().

Here is the caller graph for this function:

getHelpSectionsForId()

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

static

Get help sections for screen id.

Parameters

return

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilAccess = $DIC->access();
        $ilSetting = $DIC->settings();
        $rbacreview = $DIC->rbac()->review();
        $ilUser = $DIC->user();
        $ilObjDataCache = $DIC["ilObjDataCache"];
 
        if (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", "", (int) $a_ref_id)) {
                            $perm = $rbacreview->getUserPermissionsOnObject($ilUser->getId(), (int) $a_ref_id);
                            foreach ($perm as $p) {
                                if (substr($p, 0, 7) == "create_") {
                                    $has_create_perm = true;
                                }
                            }
                        }
                        if ($has_create_perm) {
                            $chaps[] = $rec["chap"];
                        }
                    } elseif ($ilAccess->checkAccess($rec["perm"], "", (int) $a_ref_id)) {
                        $chaps[] = $rec["chap"];
                    }
                } else {
                    $chaps[] = $rec["chap"];
                }
            }
        }
        return $chaps;
    }

References $DIC, $ilDB, $ilSetting, $ilUser, and ilObject\_lookupObjId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getScreenIdsOfChapter()

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

static

Get screen ids of chapter.

Parameters

return

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

    {
        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;
    }

References $DIC, and $ilDB.

Referenced by ilHelpMappingTableGUI\fillRow().

Here is the caller graph for this function:

hasScreenIdSections()

static ilHelpMapping::hasScreenIdSections (   $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.

Parameters

return

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilAccess = $DIC->access();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        
        if ($ilUser->getLanguage() != "de") {
            return false;
        }
        
        if ($ilSetting->get("help_mode") == "2") {
            return false;
        }
 
        if (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;
    }

References $DIC, $ilDB, $ilSetting, and $ilUser.

Referenced by ilHelpGUI\hasSections().

Here is the caller graph for this function:

removeScreenIdsOfChapter()

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

static

Remove screen ids of chapter.

Parameters

return

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

    {
        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")
            );
    }

References $DIC, and $ilDB.

Referenced by ilStructureObject\delete(), and saveScreenIdsForChapter().

Here is the caller graph for this function:

saveMappingEntry()

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

static

Save mapping entry.

Parameters

return

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

      {
        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()
            );
    }

References $DIC, and $ilDB.

Referenced by ilHelpDataSet\importRecord().

Here is the caller graph for this function:

saveScreenIdsForChapter()

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

static

Save screen ids for chapter.

Parameters

return

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        self::removeScreenIdsOfChapter($a_chap);
        if (is_array($a_ids)) {
            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()
                        );
                }
            }
        }
    }

References $DIC, $ilDB, and removeScreenIdsOfChapter().

Referenced by ilObjContentObjectGUI\saveHelpMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$db

ilHelpMapping::$db

protected

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

---

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

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