ilHelp 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 ilHelp:

Static Public Member Functions
static	getTooltipPresentationText (string $a_tt_id)
static	getObjCreationTooltipText (string $a_type)
	Get object_creation tooltip tab text. More...
static	getMainMenuTooltip (string $a_item_id)
static	getAllTooltips (string $a_comp="", int $a_module_id=0)
static	addTooltip (string $a_tt_id, string $a_text, int $a_module_id=0)
static	updateTooltip (int $a_id, string $a_text, string $a_tt_id)
static	getTooltipComponents (int $a_module_id=0)
	Get all tooltip components. More...
static	deleteTooltip (int $a_id)
static	deleteTooltipsOfModule (int $a_id)
static	getHelpLMId ()
	Get help lm id. More...

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 Online help application class

Author

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

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

Member Function Documentation

addTooltip()

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

static

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

References $DIC, and $ilDB.

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

     : void {
        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 ( int  $a_id )

static

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

References $DIC, and $ilDB.

Referenced by ilObjContentObjectGUI\deleteTooltips().

     : void {
        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 ( int  $a_id )

static

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

References $DIC, and $ilDB.

Referenced by ilObjHelpSettings\deleteModule().

     : void {
        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 ( string  $a_comp = "", int  $a_module_id = 0  )

static

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

References $DIC, and $ilDB.

Referenced by ilHelpTooltipTableGUI\__construct().

     : array {
        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 228 of file class.ilHelp.php.

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

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

                                        : int
    {
        global $DIC;

        $ilSetting = $DIC->settings();

        $lm_id = 0;

        if ((int) OH_REF_ID > 0) {
            $lm_id = ilObject::_lookupObjId((int) OH_REF_ID);
        } else {
            $hm = (int) $ilSetting->get("help_module");
            if ($hm > 0) {
                $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 ( string  $a_item_id )

static

Returns

string tooltip text

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

Referenced by ilHelpViewLayoutProvider\getMainBarModification().

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

Here is the caller graph for this function:

getObjCreationTooltipText()

static ilHelp::getObjCreationTooltipText ( string  $a_type )

static

Get object_creation tooltip tab text.

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

Referenced by ilObjectAddNewItemGUI\getHTML(), ilEmployeeTalkMyStaffListGUI\loadActionBar(), and ilEmployeeTalkMyStaffUserGUI\loadActionBar().

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

Here is the caller graph for this function:

getTooltipComponents()

static ilHelp::getTooltipComponents ( int  $a_module_id = 0 )

static

Get all tooltip components.

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

References $DIC, $ilDB, and $lng.

Referenced by ilObjContentObjectGUI\showTooltipList().

     : array {
        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 ( string  $a_tt_id )

static

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

References $DIC, $ilDB, $ilSetting, $ilUser, and ILIAS\Repository\int().

Referenced by ilHelpGUI\getTabTooltipText().

     : string {
        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 (defined('OH_REF_ID') && (int) 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 (is_array($rec) && $rec["tt_text"] != "") {
            $t = $rec["tt_text"];
            if ($module_id === 0) {
                $t .= "<br/><i>(" . $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 (is_array($rec) && $rec["tt_text"] != "") {
                $t = $rec["tt_text"];
                if ($module_id === 0) {
                    $t .= "<br/><i>(" . $a_tt_id . ")</i>";
                }
                return $t;
            }
        }
        if ($module_id === 0) {
            return "<i>" . $a_tt_id . "</i>";
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateTooltip()

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

static

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

References $DIC, and $ilDB.

Referenced by ilObjContentObjectGUI\saveTooltips().

     : void {
        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