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

Go to the source code of this file.

Namespaces

namespace  CLHOME

Functions

 insert_course_tool ($tool_label)
 get_course_tool_settings ($toolId)
 set_course_tool_visibility ($toolId, $value)
 set_local_course_tool ($toolId, $name, $url)
 insert_local_course_tool ($name, $url, $visibility=true)
 delete_course_tool ($toolId)
 get_next_course_tool_rank ()
 offset_course_tool_rank_from ($startRank, $offset=1)
 move_up_course_tool ($toolId)
 move_down_course_tool ($toolId)
 move_course_tool ($reqToolId, $moveDirection)

Function Documentation

delete_course_tool ( toolId  ) 
Author:
Hugues Peeters <hugues.peeters@claroline.net>
Christophe Gesche
Parameters:
int $toolId
Returns:
bool true if it succeeds, false otherwise

Definition at line 229 of file course_home.lib.php.

get_course_tool_settings ( toolId  ) 

Get all the settings from a specific tool

Author:
Hugues Peeters <hugues.peeters@claroline.net>
Parameters:
int $toolId id of the tool
Returns:
array containing 'id', 'name', 'visibility', 'rank', 'url', 'label', 'icon', 'access_manager'

Definition at line 78 of file course_home.lib.php.

get_next_course_tool_rank (  ) 
Author:
Hugues Peeters <hugues.peeters@claroline.net>
Returns:
int

Definition at line 249 of file course_home.lib.php.

insert_course_tool ( tool_label  ) 

insert a new claroline standart course tool into the course TODO : use this function in course/create.php (note by mla)

Author:
Hugues Peeters <hugues.peeters@claroline.net>
Parameters:
string $tool_label
Returns:
void

Definition at line 28 of file course_home.lib.php.

insert_local_course_tool ( name,
url,
visibility = true 
)
Author:
Hugues Peeters <hugues.peeters@claroline.net>
Parameters:
string $name
string $url
boolean $visibility
Returns:
bool true if it succeeds, false otherwise

Definition at line 193 of file course_home.lib.php.

move_course_tool ( reqToolId,
moveDirection 
)

move a tool up or down

Author:
Hugues Peeters <hugues.peeters@claroline.net>
Parameters:
int $reqToolId - the tool to move
string $moveDirection - should be 'UP' or 'DOWN'
Returns:

Definition at line 310 of file course_home.lib.php.

move_down_course_tool ( toolId  ) 

Definition at line 294 of file course_home.lib.php.

move_up_course_tool ( toolId  ) 

Definition at line 289 of file course_home.lib.php.

offset_course_tool_rank_from ( startRank,
offset = 1 
)

offset the tools rank from a start rank until a certain number of rank leaving free ranks between both

Author:
Hugues Peeters <hugues.peeters@claroline.net>
Parameters:
int $startRank
inti $offset (optional)
Returns:
boolean true if succeeds, false otherwise

Definition at line 272 of file course_home.lib.php.

set_course_tool_visibility ( toolId,
value 
)

Set the visibility of this tool.

Parameters:
int $toolId
boolean $value
Returns:

Definition at line 122 of file course_home.lib.php.

set_local_course_tool ( toolId,
name,
url 
)

Update an local tool data

Author:
Hugues Peeters <hugues.peeters@claroline.net>
Parameters:
int $toolId tool to update
string $name new name
string $url new url
Returns:
bool true if it suceeds, false otherwise

Definition at line 149 of file course_home.lib.php.

Generated on Tue Jun 8 12:28:37 2010 for Claroline API by  doxygen 1.6.3