Namespaces
namespace	mod
	Local Library of functions for module scorm.
Functions
	url_supports ($feature)
	url_get_extra_capabilities ()
	url_reset_userdata ($data)
	url_get_view_actions ()
	url_get_post_actions ()
	url_add_instance ($data, $mform)
	url_update_instance ($data, $mform)
	url_delete_instance ($id)
	url_user_outline ($course, $user, $mod, $url)
	url_user_complete ($course, $user, $mod, $url)
	url_get_participants ($urlid)
	url_get_coursemodule_info ($coursemodule)
	url_extend_navigation ($navigation, $course, $module, $cm)
	url_page_type_list ($pagetype, $parentcontext, $currentcontext)
	url_export_contents ($cm, $baseurl)

Function Documentation

url_add_instance	(	$	data,
		$	mform
	)

Add url instance.

Parameters:

object	$data
object	$mform

Returns:: int new url instance id

Definition at line 90 of file lib.php.

Here is the call graph for this function:

url_delete_instance ( $ id )

Delete url instance.

Parameters:

int $id

Returns:: bool true

Definition at line 173 of file lib.php.

url_export_contents	(	$	cm,
		$	baseurl
	)

Export URL resource contents

Returns:: array of file content

Definition at line 335 of file lib.php.

Here is the call graph for this function:

url_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 url 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 310 of file lib.php.

url_get_coursemodule_info ( $ coursemodule )

Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing.

See get_array_of_activities() in course/lib.php

Parameters:

object $coursemodule

Returns:: object info

Definition at line 260 of file lib.php.

Here is the call graph for this function:

url_get_extra_capabilities ( )

Returns all other caps used in module

Returns:: array

Definition at line 55 of file lib.php.

url_get_participants ( $ urlid )

Returns the users with data in one url

Todo:: : deprecated - to be deleted in 2.2

Parameters:

int $urlid

Returns:: bool false

Definition at line 246 of file lib.php.

url_get_post_actions ( )

List of update style log actions

Returns:: array

Definition at line 80 of file lib.php.

url_get_view_actions ( )

List of view style log actions

Returns:: array

Definition at line 72 of file lib.php.

url_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 325 of file lib.php.

url_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.

url_supports ( $ feature )

List of features supported in URL 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.

url_update_instance	(	$	data,
		$	mform
	)

Update url instance.

Parameters:

object	$data
object	$mform

Returns:: bool true

Definition at line 131 of file lib.php.

Here is the call graph for this function:

url_user_complete	(	$	course,
		$	user,
		$	mod,
		$	url
	)

Return use complete

Parameters:

object	$course
object	$user
object	$mod
object	$url

Definition at line 220 of file lib.php.

Here is the call graph for this function:

url_user_outline	(	$	course,
		$	user,
		$	mod,
		$	url
	)

Return use outline

Parameters:

object	$course
object	$user
object	$mod
object	$url

Returns:: object|null

Definition at line 195 of file lib.php.

Namespaces

Functions

Function Documentation