SkipLinks Class Reference

Static Public Member Functions
static	addLink (string $name, string $url, $position=null, bool $inFullscreen=true)
static	addIndex ($name, $id, $position=null, bool $inFullscreen=true)
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, bool  $inFullscreen = true  )

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
bool	$inFullscreen	is this link relevant in fullscreen mode?

addLink()

static addLink ( string  $name, string  $url,   $position = null, bool  $inFullscreen = true  )

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

getHTML()

static getHTML ( )

static

Returns the formatted list of skip links

Returns

string the formatted list of skip links

---

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

• lib/classes/SkipLinks.php