SkipLinks Class Reference

Collaboration diagram for SkipLinks:

Static Public Member Functions
static	insertContainer ()
static	addLink ($name, $url, $position=null, $overwriteable=false)
static	addIndex ($name, $id, $position=null, $overwriteable=false)
static	getHTML ()

Detailed Description

The SkipLinks class provides utility functions to handle the integration of skip links.

Member Function Documentation

addIndex()

static addIndex (   $name,   $id,   $position = null,   $overwriteable = false  )

static

Adds a link to an anker on the same page to the list of skip links.

Parameters

string	$name	the displayed name of the links
string	$id	the id of the anker
integer	$position	the position of the link in the list
boolean	$overwriteable	false if position is not overwritable by another link

Here is the caller graph for this function:

addLink()

static addLink (   $name,   $url,   $position = null,   $overwriteable = false  )

static

Adds a link to the list of skip links.

Parameters

string	$name	the displayed name of the links
string	$url	the url of the links
integer	$position	the position of the link in the list
boolean	$overwriteable	false if position is not overwritable by another link

Here is the call graph for this function:

getHTML()

static getHTML ( )

static

Returns the formatted list of skip links

Returns

string the formatted list of skip links

Here is the call graph for this function:

insertContainer()

static insertContainer ( )

static

Inserts container for skip links in page layout.

Here is the call graph for this function:

---

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

• lib/classes/SkipLinks.php