ilHelp Class Reference

ILIAS context sensitive online help class. More...

Collaboration diagram for ilHelp:

Public Member Functions
	ilHelp ()
	constructor
	setTarget ($a_target_name)
	set target help page
	getHelpPage ()
	get help page for current target list

Data Fields
	$help_targets

Detailed Description

ILIAS context sensitive online help class.

An instance of this class is global available via $ilHelp

Usage: $ilHelp->setTarget(<target_name>), example $ilHelp->setTarget("lm_editor");

All targets are listed in Services/Help/help_targets.txt

Author

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

Version

Id:

class.ilHelp.php 22976 2010-02-15 09:50:50Z akill

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

Member Function Documentation

ilHelp::getHelpPage

(

)

get help page for current target list

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

References $_SESSION, and $file.

        {
                global $ilUser;

                // check target files
                for($i = (count($_SESSION["il_help_targets"]) - 1); $i>=0; $i--)
                {
                        $file = "./docs/userdoc/".$ilUser->getLanguage().
                                "/lm_pg_".$_SESSION["il_help_targets"][$i].".html";

                        if (is_file($file))
                        {
                                return $file;
                        }
                }
                
                $file = "./docs/userdoc/".$ilUser->getLanguage().
                        "/index.html";

                if (is_file($file))
                {
                        return $file;
                }
                
                return false;
        }

ilHelp::ilHelp

(

)

constructor

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

References $_GET, and $_SESSION.

        {
                if (isset($_GET["baseClass"]) && strtolower($_GET["baseClass"]) != "ilhelpgui")
                {
                        $_SESSION["il_help_targets"] = array();
                }
        }

ilHelp::setTarget

(

$a_target_name

)

set target help page

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

References $_SESSION.

        {
                $_SESSION["il_help_targets"][] = $a_target_name;
        }

Field Documentation

ilHelp::$help_targets

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

---

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

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