claroline/claroline/inc/lib/icon.lib.php File Reference

Go to the source code of this file.

Namespaces
namespace	KERNEL
Functions
	get_current_iconset_path ()
	get_current_iconset_url ()
	get_icon ($fileName)
	get_icon_url ($fileName, $moduleLabel=null)
	claro_html_icon ($fileName, $toolTip=null, $alternate=null)
	claro_html_icon_button ($targetUrl, $iconName= '', $buttonText= '', $toolTip= '')

---

Function Documentation

claro_html_icon	(	$	fileName,
		$	toolTip = null,
		$	alternate = null
	)

Includes an icon in html code

Parameters:

	string	fileName file name with or without extension
	string	toolTip tooltip for the image (optional, default none)
	string	alternate alt text for the image (optional, default fileName)

Returns:

string html code for the image

Definition at line 134 of file icon.lib.php.

claro_html_icon_button	(	$	targetUrl,
		$	iconName = '',
		$	buttonText = '',
		$	toolTip = ''
	)

Add a claroCmd button with icon to HTML output

Parameters:

	string	targetUrl url of the target page
	string	iconName name of the icon with or without file extension (optional, default none)
	string	buttonText text of the button (optional, default none)
	string	toolTip tooltip of the button (optional, default none)

Definition at line 169 of file icon.lib.php.

get_current_iconset_path

(

)

Returns the (system) path to the current iconset

Definition at line 24 of file icon.lib.php.

get_current_iconset_url

(

)

Returns the (web) url to the current iconset

Definition at line 32 of file icon.lib.php.

get_icon

(

$

fileName

)

Returns the url of the given icon, replaced by get_icon_url()

Deprecated:

Since:

v1.9

See also:

get_icon_url()

Definition at line 44 of file icon.lib.php.

get_icon_url	(	$	fileName,
		$	moduleLabel = null
	)

Returns the url of the given icon

Parameters:

	string	$fileName file name with or without extension
	string	$moduleLabel label of the module (optional)

Returns:

string icon url mixed null if icon not found

Definition at line 58 of file icon.lib.php.