claroline/claroline/messaging/lib/tools.lib.php File Reference

Go to the source code of this file.

Namespaces
namespace	internal_messaging
Functions
	makeArgLink ($paramList, $without=array())
	getBarMessageBox ($currentUserId, $currentSection)
	claro_is_user_platform_admin ($userId)
	claro_is_user_course_manager ($userId, $courseCode)
	getPager ($link, $currentPage, $totalPage)

---

Function Documentation

claro_is_user_course_manager	(	$	userId,
		$	courseCode
	)

return true if the user in parameter is manager of the course in 2nd parameters

Parameters:

	int	$userId user id
	string	$courseCode syscode du cours

Returns:

boolean true if the user is manager of the course false if the user is not manager of the course

Definition at line 101 of file tools.lib.php.

claro_is_user_platform_admin

(

$

userId

)

return true if the user in parameter is admin, false is the user in parameter is not admin

Parameters:

int

$userId

Returns:

bool true if the user is admin false if the user is not admin

Definition at line 84 of file tools.lib.php.

getBarMessageBox	(	$	currentUserId,
		$	currentSection
	)

return the HTML source for the menu bar (to navigate between message box)

Parameters:

int

$currentUserId user identification (the admin read message box of an other user)

Returns:

string HTML source

Definition at line 50 of file tools.lib.php.

getPager	(	$	link,
		$	currentPage,
		$	totalPage
	)

return the pager

Parameters:

	string	$link link of the page to display(without page=x)
	int	$currentPage current page
	int	$totalPage number of page

Returns:

string HTML source of the pager

Definition at line 123 of file tools.lib.php.

makeArgLink	(	$	paramList,
		$	without = array()
	)

create a argument string for a link

Parameters:

	array	of string $paramList array of all argument
	array	of string $without array of argument name to don't add to the link

Returns:

string arguments of the url

Definition at line 25 of file tools.lib.php.