claroline/claroline/inc/lib/core/helpers.lib.php File Reference

Go to the source code of this file.

Namespaces
namespace	KERNEL
Functions
	make_attribute_list ($attributes)
	link_to ($text, $url, $attributes=null)
	link_to_claro ($text, $url=null, $context=null, $attributes=null)
	link_to_course ($text, $courseId, $attributes=null)
	link_to_tool ($text, $toolLabel=null, $context=null, $attributes=null)
	include_dock ($dockName)
	include_template ($template)
	include_textzone ($textzone, $defaultContent=null)
	link_to_css ($css, $media= 'all')

---

Function Documentation

include_dock

(

$

dockName

)

Include the rendering of the given dock

Parameters:

string

dock name

Returns:

string rendering

Definition at line 137 of file helpers.lib.php.

include_template

(

$

template

)

Include a template file

Parameters:

string

$template name of the template

Definition at line 147 of file helpers.lib.php.

include_textzone	(	$	textzone,
		$	defaultContent = null
	)

Include a textzone file

Parameters:

	string	$textzone name of the textzone
	string	$defaultContent content displayed if textzone cannot be found or doesn't exist

Definition at line 175 of file helpers.lib.php.

link_to	(	$	text,
		$	url,
		$	attributes = null
	)

Create an html link to the given url with the given text and attributes

Parameters:

	string	text
	string	url
	array	attributes (optional)

Returns:

string

Definition at line 53 of file helpers.lib.php.

link_to_claro	(	$	text,
		$	url = null,
		$	context = null,
		$	attributes = null
	)

Create an html link to the given url inside claroline with the given text and attributes

Parameters:

	string	text
	string	url inside claroline
	array	context (cid, gid)
	array	attributes (optional)

Returns:

string

Definition at line 75 of file helpers.lib.php.

link_to_course	(	$	text,
		$	courseId,
		$	attributes = null
	)

Create an html link to the given course or course tool text and attributes

Parameters:

	string	text
	string	courseId
	array	attributes (optional)

Returns:

string

Definition at line 106 of file helpers.lib.php.

link_to_css	(	$	css,
		$	media = 'all'
	)

Include the link to a given css

Parameters:

	name	of the css without the complete path
	css	media

Returns:

string

Definition at line 231 of file helpers.lib.php.

link_to_tool	(	$	text,
		$	toolLabel = null,
		$	context = null,
		$	attributes = null
	)

Create an html link to the given course or course tool text and attributes

Parameters:

	string	text
	string	toolLabel
	array	context (cid, gid)
	array	attributes (optional)

Returns:

string

Definition at line 125 of file helpers.lib.php.

make_attribute_list

(

$

attributes

)

Create an html attribute list from an associative array attribute=>value

Parameters:

array

$attributes

Returns:

string

Definition at line 29 of file helpers.lib.php.