ilHelp Class Reference

Online help application class. More...

Collaboration diagram for ilHelp:

Static Public Member Functions
static	getTooltipPresentationText ($a_tt_id)
	Get tooltip for id. More...
static	getObjCreationTooltipText ($a_type)
	Get object_creation tooltip tab text. More...
static	getMainMenuTooltip ($a_item_id)
	Get main menu tooltip. More...
static	getAllTooltips ($a_comp="", $a_module_id=0)
	Get all tooltips. More...
static	addTooltip ($a_tt_id, $a_text, $a_module_id=0)
	Add tooltip. More...
static	updateTooltip ($a_id, $a_text, $a_tt_id)
	Update tooltip. More...
static	getTooltipComponents ($a_module_id=0)
	Get all tooltip components. More...
static	deleteTooltip ($a_id)
	Delete tooltip. More...
static	deleteTooltipsOfModule ($a_id)
	Delete tooltips of module. More...
static	getHelpLMId ()
	Get help lm id. More...

Detailed Description

Online help application class.

Author

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

Version

$Id$

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

Member Function Documentation

addTooltip()

static ilHelp::addTooltip (   $a_tt_id,   $a_text,   $a_module_id = 0  )

static

Add tooltip.

Parameters

Definition at line 139 of file class.ilHelp.php.

References $DIC, and $ilDB.

Referenced by ilObjContentObjectGUI\addTooltip(), and ilHelpDataSet\importRecord().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $fu = strpos($a_tt_id, "_");
        $comp = substr($a_tt_id, 0, $fu);
        
        $nid = $ilDB->nextId("help_tooltip");
        $ilDB->manipulate("INSERT INTO help_tooltip " .
            "(id, tt_text, tt_id, comp,module_id) VALUES (" .
            $ilDB->quote($nid, "integer") . "," .
            $ilDB->quote($a_text, "text") . "," .
            $ilDB->quote($a_tt_id, "text") . "," .
            $ilDB->quote($comp, "text") . "," .
            $ilDB->quote($a_module_id, "integer") .
            ")");
    }

Here is the caller graph for this function:

deleteTooltip()

static ilHelp::deleteTooltip (   $a_id )

static

Delete tooltip.

Parameters

Definition at line 213 of file class.ilHelp.php.

References $DIC, and $ilDB.

Referenced by ilObjContentObjectGUI\deleteTooltips().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $ilDB->manipulate(
            "DELETE FROM help_tooltip WHERE " .
            " id = " . $ilDB->quote($a_id, "integer")
        );
    }

Here is the caller graph for this function:

deleteTooltipsOfModule()

static ilHelp::deleteTooltipsOfModule (   $a_id )

static

Delete tooltips of module.

Parameters

Definition at line 231 of file class.ilHelp.php.

References $DIC, and $ilDB.

Referenced by ilObjHelpSettings\deleteModule().

    {
        global $DIC;

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

Here is the caller graph for this function:

getAllTooltips()

static ilHelp::getAllTooltips (   $a_comp = "",   $a_module_id = 0  )

static

Get all tooltips.

Parameters

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

References $DIC, and $ilDB.

Referenced by ilHelpTooltipTableGUI\__construct().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $q = "SELECT * FROM help_tooltip";
        $q .= " WHERE module_id = " . $ilDB->quote($a_module_id, "integer");
        if ($a_comp != "") {
            $q .= " AND comp = " . $ilDB->quote($a_comp, "text");
        }
        $set = $ilDB->query($q);
        $tts = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $tts[$rec["id"]] = array("id" => $rec["id"], "text" => $rec["tt_text"],
                "tt_id" => $rec["tt_id"]);
        }
        return $tts;
    }

Here is the caller graph for this function:

getHelpLMId()

static ilHelp::getHelpLMId ( )

static

Get help lm id.

Returns

int help learning module id

Definition at line 248 of file class.ilHelp.php.

References $DIC, $ilSetting, ilObject\_lookupObjId(), and ilObjHelpSettings\lookupModuleLmId().

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

    {
        global $DIC;

        $ilSetting = $DIC->settings();

        $lm_id = 0;

        if (OH_REF_ID > 0) {
            $lm_id = ilObject::_lookupObjId(OH_REF_ID);
        } else {
            $hm = (int) $ilSetting->get("help_module");
            if ($hm > 0) {
                include_once("./Services/Help/classes/class.ilObjHelpSettings.php");
                $lm_id = ilObjHelpSettings::lookupModuleLmId($hm);
            }
        }

        return $lm_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMainMenuTooltip()

static ilHelp::getMainMenuTooltip (   $a_item_id )

static

Get main menu tooltip.

Parameters

string

$a_mm_id

Returns

string tooltip text

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

Referenced by ilMMTopParentItemRenderer\addEntry(), ilMainMenuGUI\addToolbarTooltip(), ilAdministrationGUI\getDropDown(), ilMMTopParentItemRenderer\handleAsyncContent(), and ilMMTopParentItemRenderer\handleContent().

    {
        return self::getTooltipPresentationText($a_item_id);
    }

Here is the caller graph for this function:

getObjCreationTooltipText()

static ilHelp::getObjCreationTooltipText (   $a_type )

static

Get object_creation tooltip tab text.

Parameters

string

$a_tab_id

tab id

Returns

string tooltip text

Definition at line 90 of file class.ilHelp.php.

References $a_type.

Referenced by ilObjectAddNewItemGUI\getHTML().

    {
        return self::getTooltipPresentationText($a_type . "_create");
    }

Here is the caller graph for this function:

getTooltipComponents()

static ilHelp::getTooltipComponents (   $a_module_id = 0 )

static

Get all tooltip components.

Parameters

Definition at line 190 of file class.ilHelp.php.

References $DIC, $ilDB, and $lng.

Referenced by ilObjContentObjectGUI\showTooltipList().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $lng = $DIC->language();
        
        $set = $ilDB->query("SELECT DISTINCT comp FROM help_tooltip " .
            " WHERE module_id = " . $ilDB->quote($a_module_id, "integer") .
            " ORDER BY comp ");
        $comps[""] = "- " . $lng->txt("help_all") . " -";
        while ($rec = $ilDB->fetchAssoc($set)) {
            $comps[$rec["comp"]] = $rec["comp"];
        }
        return $comps;
    }

Here is the caller graph for this function:

getTooltipPresentationText()

static ilHelp::getTooltipPresentationText (   $a_tt_id )

static

Get tooltip for id.

Parameters

Definition at line 19 of file class.ilHelp.php.

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

Referenced by ilHelpGUI\getTabTooltipText().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        
        
        if ($ilUser->getLanguage() != "de") {
            return "";
        }
        
        if ($ilSetting->get("help_mode") == "1") {
            return "";
        }

        if ($ilUser->getPref("hide_help_tt")) {
            return "";
        }
        
        if (OH_REF_ID > 0) {
            $module_id = 0;
        } else {
            $module_id = (int) $ilSetting->get("help_module");
            if ($module_id == 0) {
                return "";
            }
        }
        
        $set = $ilDB->query(
            "SELECT tt_text FROM help_tooltip " .
            " WHERE tt_id = " . $ilDB->quote($a_tt_id, "text") .
            " AND module_id = " . $ilDB->quote($module_id, "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        if ($rec["tt_text"] != "") {
            $t = $rec["tt_text"];
            if ($module_id == 0) {
                $t .= "<br/><i class='small'>" . $a_tt_id . "</i>";
            }
            return $t;
        } else { // try to get general version
            $fu = strpos($a_tt_id, "_");
            $gen_tt_id = "*" . substr($a_tt_id, $fu);
            $set = $ilDB->query(
                "SELECT tt_text FROM help_tooltip " .
                " WHERE tt_id = " . $ilDB->quote($gen_tt_id, "text") .
                " AND module_id = " . $ilDB->quote($module_id, "integer")
            );
            $rec = $ilDB->fetchAssoc($set);
            if ($rec["tt_text"] != "") {
                $t = $rec["tt_text"];
                if ($module_id == 0) {
                    $t .= "<br/><i class='small'>" . $a_tt_id . "</i>";
                }
                return $t;
            }
        }
        if ($module_id == 0) {
            return "<i>" . $a_tt_id . "</i>";
        }
        return "";
    }

Here is the caller graph for this function:

updateTooltip()

static ilHelp::updateTooltip (   $a_id,   $a_text,   $a_tt_id  )

static

Update tooltip.

Parameters

Definition at line 165 of file class.ilHelp.php.

References $DIC, and $ilDB.

Referenced by ilObjContentObjectGUI\saveTooltips().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $fu = strpos($a_tt_id, "_");
        $comp = substr($a_tt_id, 0, $fu);
        
        $ilDB->manipulate(
            "UPDATE help_tooltip SET " .
            " tt_text = " . $ilDB->quote($a_text, "text") . ", " .
            " tt_id = " . $ilDB->quote($a_tt_id, "text") . ", " .
            " comp = " . $ilDB->quote($comp, "text") .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
    }

Here is the caller graph for this function:

---

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

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