Procedural File: userInfoLib.php

Source Location: /main/user/userInfoLib.php

Page Details:

cleanout_cat_content [line 408]

- cleanout_cat_content(
- $user_id,  $definition_id, - $definition_id,)

clean the content of a bloc for information category

Tags:

return:	boolean true if succeed, else bolean false
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$definition_id,
-	$user_id
	$definition_id

[ Top ]

create_cat_def [line 44]

- create_cat_def(
[- $title = &quot;&quot;], [- $comment = &quot;&quot;], [- $nbline = &quot;5&quot;])

create a new category definition for the user information

Tags:

return:	bollean true if succeed, else bolean false
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$title	string $title - category title
-	$comment	string $comment - title comment
-	$nbline	int$nbline - lines number for the field the user will fill.

[ Top ]

edit_cat_content [line 364]

- edit_cat_content(
 $definition_id,  $user_id, [- $content = &quot;&quot;], [ $user_ip = &quot;&quot;], - $definition_id,, - $user_id,, - $user_ip,)

edit a bloc for information category

Tags:

return:	boolean true if succeed, else bolean false
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$definition_id,
-	$user_id,
-	$user_ip,	DEFAULT $REMOTE_ADDR
-	$content	; if empty call delete the bloc
	$definition_id
	$user_id
	$user_ip

[ Top ]

edit_cat_def [line 87]

- edit_cat_def(
- $id, - $title, - $comment, - $nbline)

modify the definition of a user information category

Tags:

return:	boolean true if succeed, else otherwise
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$id	int $id - id of the category
-	$title	string $title - category title
-	$comment	string $comment - title comment
-	$nbline	int$nbline - lines number for the field the user will fill.

[ Top ]

fill_new_cat_content [line 306]

- fill_new_cat_content(
 $definition_id,  $user_id, [- $content = &quot;&quot;], [ $user_ip = &quot;&quot;], - $definition_id,, - $user_id,, - $user_ip,)

fill a bloc for information category

Tags:

return:	boolean true if succeed, else bolean false
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$definition_id,
-	$user_id,
-	$user_ip,
-	$content
	$definition_id
	$user_id
	$user_ip

[ Top ]

get_cat_content [line 519]

- get_cat_content(
- $userId, - $catId)

get the user content of a categories plus the categories definition

Tags:

return:	array containing 'catId', 'title', 'comment', 'nbline', 'contentId' and 'content'
author:	- Hugues Peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$userId	int $userId - id of the user
-	$catId	int $catId - id of the categories

[ Top ]

get_cat_def [line 554]

- get_cat_def(
- $catId)

get the definition of a category

Tags:

return:	array containing 'id', 'title', 'comment', and 'nbline',
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>
author:	- Hugues Peeters <peeters@ipm.ucl.ac.be>

Parameters

$catId

int $catId - id of the categories

[ Top ]

get_cat_def_list [line 584]

- get_cat_def_list(
)

get list of all this course categories

Tags:

return:	array containing a list of arrays. And each of these arrays contains 'catId', 'title', 'comment', and 'nbline',
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>
author:	- Hugues Peeters <peeters@ipm.ucl.ac.be>

[ Top ]

get_course_user_info [line 441]

- get_course_user_info(
- $user_id)

get the user info from the user id

Tags:

return:	array containg user info sort by categories rank each rank contains 'title', 'comment', 'content', 'cat_id'
author:	- Hugues Peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

$user_id

int $user_id user id as stored in the Dokeos main db

[ Top ]

get_main_user_info [line 477]

- get_main_user_info(
- $user_id,  $courseCode)

get the main user information

Tags:

return:	array containing user info as 'lastName', 'firstName' 'email', 'role'
author:	- Hugues Peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$user_id	int $user_id user id as stored in the Dokeos main db
	$courseCode

[ Top ]

htmlize [line 614]

void htmlize(
- $phrase)

transform content in a html display

Tags:

author:

- Hugues Peeters <peeters@ipm.ucl.ac.be>

Parameters

$phrase

string $string string to htmlize @ return - string htmlized

[ Top ]

move_cat_rank [line 169]

- move_cat_rank(
- $id, - $direction)

move a category in the category list

Tags:

return:	boolean true if succeed, else bolean false
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$id	int $id - id of the category
-	$direction	direction "up" or "down" : "up" decrease the rank of gived $id by switching rank with the just lower "down" increase the rank of gived $id by switching rank with the just upper

[ Top ]

move_cat_rank_by_rank [line 205]

- move_cat_rank_by_rank(
- $rank, - $direction)

move a category in the category list

Tags:

return:	boolean true if succeed, else bolean false
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	$rank	int $rank - actual rank of the category
-	$direction	direction "up" or "down" : "up" decrease the rank of gived $rank by switching rank with the just lower "down" increase the rank of gived $rank by switching rank with the just upper

[ Top ]

remove_cat_def [line 124]

- remove_cat_def(
- $id, [- $force = false], - 2)

remove a category from the category list

Tags:

return:	bollean - TRUE if succeed, ELSE otherwise
author:	- Hugues peeters <peeters@ipm.ucl.ac.be>
author:	- Christophe Gesché <gesche@ipm.ucl.ac.be>

Parameters

-	2	int $nbline - lines number for the field the user will fill.
-	$id	int $id - id of the category or "ALL" for all category
-	$force	boolean $force - FALSE (default) : prevents removal if users have already fill this category TRUE : bypass user content existence check

[ Top ]

replace_dangerous_char [line 628]

- replace_dangerous_char(
- $string)

replaces some dangerous character in a string for HTML use

Tags:

return:	the string cleaned of dangerous character
author:	- Hugues Peeters <peeters@ipm.ucl.ac.be>

Parameters

$string

string (string) string

[ Top ]

update_user_course_properties [line 259]

boolean update_user_course_properties(
int $user_id, string $course_code, array $properties)

Tags:

return:	true if succeed false otherwise
author:	Hugues Peeters - peeters@ipm.ucl.ac.be

Parameters

int	$user_id
string	$course_code
array	$properties	- should contain 'role', 'status', 'tutor_id'

[ Top ]

Documentation generated on Wed, 05 Sep 2007 06:15:13 +0200 by phpDocumentor 1.4.0