Namespaces
namespace	mod
	Local Library of functions for module scorm.
Functions
	folder_supports ($feature)
	folder_get_extra_capabilities ()
	folder_reset_userdata ($data)
	folder_get_view_actions ()
	folder_get_post_actions ()
	folder_add_instance ($data, $mform)
	folder_update_instance ($data, $mform)
	folder_delete_instance ($id)
	folder_user_outline ($course, $user, $mod, $folder)
	folder_user_complete ($course, $user, $mod, $folder)
	folder_get_participants ($folderid)
	folder_get_file_areas ($course, $cm, $context)
	folder_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
	folder_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload)
	folder_extend_navigation ($navigation, $course, $module, $cm)
	folder_page_type_list ($pagetype, $parentcontext, $currentcontext)
	folder_export_contents ($cm, $baseurl)

Function Documentation

folder_add_instance	(	$	data,
		$	mform
	)

Add folder instance.

Parameters:

object	$data
object	$mform

Returns:: int new folder instance id

Definition at line 90 of file lib.php.

Here is the call graph for this function:

folder_delete_instance ( $ id )

Delete folder instance.

Parameters:

int $id

Returns:: bool true

Definition at line 141 of file lib.php.

folder_export_contents	(	$	cm,
		$	baseurl
	)

Export folder resource contents

Returns:: array of file content

Definition at line 357 of file lib.php.

Here is the call graph for this function:

folder_extend_navigation	(	$	navigation,
		$	course,
		$	module,
		$	cm
	)

This function extends the global navigation for the site. It is important to note that you should not rely on PAGE objects within this body of code as there is no guarantee that during an AJAX request they are available

Parameters:

navigation_node	$navigation	The folder node within the global navigation
stdClass	$course	The course object returned from the DB
stdClass	$module	The module object returned from the DB
stdClass	$cm	The course module instance returned from the DB

This is currently just a stub so that it can be easily expanded upon. When expanding just remove this comment and the line below and then add you content.

Definition at line 332 of file lib.php.

folder_get_extra_capabilities ( )

Returns all other caps used in module

Returns:: array

Definition at line 55 of file lib.php.

folder_get_file_areas	(	$	course,
		$	cm,
		$	context
	)

Lists all browsable file areas

Parameters:

object	$course
object	$cm
object	$context

Returns:: array

Definition at line 225 of file lib.php.

folder_get_file_info	(	$	browser,
		$	areas,
		$	course,
		$	cm,
		$	context,
		$	filearea,
		$	itemid,
		$	filepath,
		$	filename
	)

File browsing support for folder module content area.

Parameters:

object	$browser
object	$areas
object	$course
object	$cm
object	$context
string	$filearea
int	$itemid
string	$filepath
string	$filename

Returns:: object file_info instance or null if not found

Definition at line 245 of file lib.php.

Here is the call graph for this function:

folder_get_participants ( $ folderid )

Returns the users with data in one folder

Todo:: : deprecated - to be deleted in 2.2

Parameters:

int $folderid

Returns:: bool false

Definition at line 214 of file lib.php.

folder_get_post_actions ( )

List of update style log actions

Returns:: array

Definition at line 80 of file lib.php.

folder_get_view_actions ( )

List of view style log actions

Returns:: array

Definition at line 72 of file lib.php.

folder_page_type_list	(	$	pagetype,
		$	parentcontext,
		$	currentcontext
	)

Return a list of page types

Parameters:

string	$pagetype	current page type
stdClass	$parentcontext	Block's parent context
stdClass	$currentcontext	Current context of block

Definition at line 347 of file lib.php.

folder_pluginfile	(	$	course,
		$	cm,
		$	context,
		$	filearea,
		$	args,
		$	forcedownload
	)

Serves the folder files.

Parameters:

object	$course
object	$cm
object	$context
string	$filearea
array	$args
bool	$forcedownload

Returns:: bool false if file not found, does not return if found - just send the file

Definition at line 290 of file lib.php.

Here is the call graph for this function:

folder_reset_userdata ( $ data )

This function is used by the reset_course_userdata function in moodlelib.

Parameters:

$data the data submitted from the reset course.

Returns:: array status array

Definition at line 64 of file lib.php.

folder_supports ( $ feature )

List of features supported in Folder module

Parameters:

string $feature FEATURE_xx constant for requested feature

Returns:: mixed True if module supports feature, false if not, null if doesn't know

Definition at line 34 of file lib.php.

folder_update_instance	(	$	data,
		$	mform
	)

Update folder instance.

Parameters:

object	$data
object	$mform

Returns:: bool true

Definition at line 116 of file lib.php.

Here is the call graph for this function:

folder_user_complete	(	$	course,
		$	user,
		$	mod,
		$	folder
	)

Return use complete

Parameters:

object	$course
object	$user
object	$mod
object	$folder

Definition at line 188 of file lib.php.

Here is the call graph for this function:

folder_user_outline	(	$	course,
		$	user,
		$	mod,
		$	folder
	)

Return use outline

Parameters:

object	$course
object	$user
object	$mod
object	$folder

Returns:: object|null

Definition at line 163 of file lib.php.

Namespaces

Functions

Function Documentation