ilAccessKey Class Reference

Access key handling. More...

Collaboration diagram for ilAccessKey:

Static Public Member Functions
static	getFunctionName ($a_func_id)
	Get Function Name. More...
static	getComponentNames ($a_func_id)
	Get Component Names. More...
static	getKeys ($lang_key="0", $a_ignore_default=false)
	Get access keys for language. More...
static	getKey ($a_func_id, $lang_key="0", $a_ignore_default=false)
	Get single access key. More...
static	writeKeys ($a_keys, $a_lang_key="0")
	Write keys. More...

Data Fields
const	NEXT = 1
const	PREVIOUS = 2
const	DELETE = 3
const	LAST_VISITED = 4
const	TREE_ON = 5
const	TREE_OFF = 6
const	REPLY = 7
const	FORWARD_MAIL = 8
const	MARK_ALL_READ = 9
const	PERSONAL_DESKTOP = 10

Static Public Attributes
static	$func_def

Static Private Member Functions
static	getAllKeysEmpty ()
	Get all function ids with empty keys. More...

Detailed Description

Access key handling.

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.ilAccessKey.php.

Member Function Documentation

getAllKeysEmpty()

static ilAccessKey::getAllKeysEmpty ( )

staticprivate

Get all function ids with empty keys.

Returns

array function id => empty string

Definition at line 63 of file class.ilAccessKey.php.

References $c, and $f.

Referenced by getKeys().

    {
        $empty_keys = array();
        foreach (self::$func_def as $f => $c) {
            $empty_keys[$f] = "";
        }
        
        return $empty_keys;
    }

Here is the caller graph for this function:

getComponentNames()

static ilAccessKey::getComponentNames (   $a_func_id )

static

Get Component Names.

Definition at line 88 of file class.ilAccessKey.php.

References $c, $DIC, and $lng.

Referenced by ilAccessKeyTableGUI\fillRow().

    {
        global $DIC;

        $lng = $DIC->language();

        $c_str = $lim = "";
        foreach (self::$func_def[$a_func_id]["component"] as $c) {
            $c_str .= $lim . $lng->txt("acc_comp_" . $c);
            $lim = ", ";
        }
        return $c_str;
    }

Here is the caller graph for this function:

getFunctionName()

static ilAccessKey::getFunctionName (   $a_func_id )

static

Get Function Name.

Definition at line 76 of file class.ilAccessKey.php.

References $DIC, and $lng.

Referenced by ilAccessKeyTableGUI\fillRow().

    {
        global $DIC;

        $lng = $DIC->language();

        return $lng->txt(self::$func_def[$a_func_id]["lang"]);
    }

Here is the caller graph for this function:

getKey()

static ilAccessKey::getKey (   $a_func_id,   $lang_key = "0",   $a_ignore_default = false  )

static

Get single access key.

Parameters

string

lang key, "0" means default values

Definition at line 138 of file class.ilAccessKey.php.

References $DIC, $ilDB, and $key.

Referenced by ilAccessKeyGUI\getAttribute(), and ilButtonBase\renderAttributes().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $key = "";
        
        // get defaults
        if ($lang_key != "0" && !$a_ignore_default) {
            $key = ilAccessKey::getKey($a_func_id);
        }
        
        // get keys of selected language
        $set = $ilDB->query(
            "SELECT * FROM acc_access_key " .
            " WHERE lang_key = " . $ilDB->quote($lang_key, "text") .
            " AND function_id = " . $ilDB->quote($a_func_id, "integer")
        );
        if ($rec = $ilDB->fetchAssoc($set)) {
            $key = $rec["access_key"];
        }
        
        return $key;
    }

Here is the caller graph for this function:

getKeys()

static ilAccessKey::getKeys (   $lang_key = "0",   $a_ignore_default = false  )

static

Get access keys for language.

Parameters

string

lang key, "0" means default values

Definition at line 108 of file class.ilAccessKey.php.

References $DIC, $ilDB, $keys, and getAllKeysEmpty().

Referenced by ilAccessKeyTableGUI\__construct().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $keys = ilAccessKey::getAllKeysEmpty();
        
        // get defaults
        if ($lang_key != "0" && !$a_ignore_default) {
            $keys = ilAccessKey::getKeys();
        }
        
        // get keys of selected language
        $set = $ilDB->query(
            "SELECT * FROM acc_access_key " .
            " WHERE lang_key = " . $ilDB->quote($lang_key, "text")
        );
        while ($rec = $ilDB->fetchAssoc($set)) {
            $keys[$rec["function_id"]] = $rec["access_key"];
        }
        
        return $keys;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeKeys()

static ilAccessKey::writeKeys (   $a_keys,   $a_lang_key = "0"  )

static

Write keys.

Parameters

array

function ids => keys

Definition at line 169 of file class.ilAccessKey.php.

References $DIC, and $ilDB.

Referenced by ilObjAccessibilitySettingsGUI\saveAccessKeys().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $ilDB->manipulate(
            "DELETE FROM acc_access_key WHERE " .
            "lang_key = " . $ilDB->quote($a_lang_key, "text")
        );
        
        foreach ($a_keys as $func_id => $acc_key) {
            $ilDB->manipulate("INSERT INTO acc_access_key " .
                "(lang_key, function_id, access_key) VALUES (" .
                $ilDB->quote($a_lang_key, "text") . "," .
                $ilDB->quote($func_id, "integer") . "," .
                $ilDB->quote(strtolower(trim($acc_key)), "text") .
                ")");
        }
    }

Here is the caller graph for this function:

Field Documentation

$func_def

ilAccessKey::$func_def

static

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

DELETE

const ilAccessKey::DELETE = 3

Definition at line 16 of file class.ilAccessKey.php.

Referenced by ilMailFolderGUI\confirmDeleteMails().

FORWARD_MAIL

const ilAccessKey::FORWARD_MAIL = 8

Definition at line 21 of file class.ilAccessKey.php.

Referenced by ilMailFolderGUI\confirmDeleteMails().

LAST_VISITED

const ilAccessKey::LAST_VISITED = 4

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

Referenced by ilNavigationHistoryGUI\getHTML().

MARK_ALL_READ

const ilAccessKey::MARK_ALL_READ = 9

Definition at line 22 of file class.ilAccessKey.php.

Referenced by ilObjForumGUI\getContent(), and ilObjForumGUI\getForumObjects().

NEXT

const ilAccessKey::NEXT = 1

Definition at line 14 of file class.ilAccessKey.php.

Referenced by ilLMPresentationGUI\ilLMNavigation().

PERSONAL_DESKTOP

const ilAccessKey::PERSONAL_DESKTOP = 10

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

PREVIOUS

const ilAccessKey::PREVIOUS = 2

Definition at line 15 of file class.ilAccessKey.php.

Referenced by ilLMPresentationGUI\ilLMNavigation().

REPLY

const ilAccessKey::REPLY = 7

Definition at line 20 of file class.ilAccessKey.php.

Referenced by ilMailFolderGUI\confirmDeleteMails().

TREE_OFF

const ilAccessKey::TREE_OFF = 6

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

Referenced by ilTemplate\fillSideIcons().

TREE_ON

const ilAccessKey::TREE_ON = 5

Definition at line 18 of file class.ilAccessKey.php.

Referenced by ilTemplate\fillSideIcons().

---

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

• Services/Accessibility/classes/class.ilAccessKey.php