mod_url

Files
file	access.php
	Capability definitions for the url module.
file	activity.php
	Search area for mod_url activities.
file	activity_base.php
	Activity base class.
file	backup_url_activity_task.class.php
	Defines backup_url_activity_task class.
file	backup_url_stepslib.php
	Define all the backup steps that will be used by the backup_url_activity_task.
file	cognitive_depth.php
	Cognitive depth indicator - url.
file	course_module_instance_list_viewed.php
	The mod_url instance list viewed event.
file	course_module_viewed.php
	The mod_url course module viewed event.
file	external.php
	URL external API.
file	install.php
	Post installation and migration code.
file	lib.php
	Provides support for the conversion of moodle1 backup to the moodle2 format.
file	lib.php
	Mandatory public API of url module.
file	lib.php
	mod_url data generator.
file	locallib.php
	Private url module utility functions.
file	log.php
	Definition of log events.
file	mod_form.php
	URL configuration form.
file	provider.php
	Privacy Subsystem implementation for mod_url.
file	restore_url_activity_task.class.php
	@subpackage backup-moodle2
file	restore_url_stepslib.php
	@subpackage backup-moodle2
file	services.php
	URL external functions and service definitions.
file	settings.php
	Url module admin settings and defaults.
file	social_breadth.php
	Social breadth indicator - url.
file	upgrade.php
	URL module upgrade code.
file	version.php
	Folder module version information.

Namespaces
namespace	mod_url\analytics\indicator
namespace	mod_url\event
namespace	mod_url\privacy
namespace	mod_url\search

Classes
class	backup_url_activity_structure_step
	Define the complete url structure for backup, with file and id annotations. More...
class	backup_url_activity_task
	Provides all the settings and steps to perform one complete backup of the activity. More...
class	mod_url\analytics\indicator\activity_base
	Activity base class. More...
class	mod_url\analytics\indicator\cognitive_depth
	Cognitive depth indicator - url. More...
class	mod_url\analytics\indicator\social_breadth
	Social breadth indicator - url. More...
class	mod_url\event\course_module_instance_list_viewed
	The mod_url instance list viewed event class. More...
class	mod_url\event\course_module_viewed
	The mod_url course module viewed event class. More...
class	mod_url\privacy\provider
	The mod_url module does not store any data. More...
class	mod_url\search\activity
	Search area for mod_url activities. More...
class	mod_url_external
class	mod_url_generator
class	mod_url_mod_form
class	moodle1_mod_url_handler
	URL conversion handler. More...
class	restore_url_activity_structure_step
	Define all the restore steps that will be used by the restore_url_activity_task. More...
class	restore_url_activity_task
	url restore task that provides all the settings and steps to perform one complete restore of the activity More...

Functions
	mod_url_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, $userid=0)
	This function receives a calendar event and returns the action associated with it, or null if there is none. More...
	url_add_instance ($data, $mform)
	Add url instance. More...
	url_appears_valid_url ($url)
	This methods does weak url validation, we are looking for major problems only, no strict RFE validation. More...
	url_check_updates_since (cm_info $cm, $from, $filter=array())
	Check if the module has any update that affects the current user since a given time. More...
	url_delete_instance ($id)
	Delete url instance. More...
	url_display_embed ($url, $cm, $course)
	Display embedded url file. More...
	url_display_frame ($url, $cm, $course)
	Display url frames. More...
	url_dndupload_handle ($uploadinfo)
	Handle a file that has been uploaded. More...
	url_dndupload_register ()
	Register the ability to handle drag and drop file uploads. More...
	url_export_contents ($cm, $baseurl)
	Export URL resource contents. More...
	url_filter_callback ($matches)
	Unicode encoding helper callback.
	url_fix_submitted_url ($url)
	Fix common URL problems that we want teachers to see fixed the next time they edit the resource. More...
	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. More...
	url_get_encrypted_parameter ($url, $config)
	BC internal function. More...
	url_get_final_display_type ($url)
	Decide the best display format. More...
	url_get_full_url ($url, $cm, $course, $config=null)
	Return full url with all extra parameters. More...
	url_get_post_actions ()
	List the actions that correspond to a post of this module. More...
	url_get_variable_options ($config)
	Get the parameters that may be appended to URL. More...
	url_get_variable_values ($url, $cm, $course, $config)
	Get the parameter values that may be appended to URL. More...
	url_get_view_actions ()
	List the actions that correspond to a view of this module. More...
	url_guess_icon ($fullurl, $size=null)
	Optimised mimetype detection from general URL. More...
	url_page_type_list ($pagetype, $parentcontext, $currentcontext)
	Return a list of page types. More...
	url_print_header ($url, $cm, $course)
	Print url header. More...
	url_print_heading ($url, $cm, $course, $notused=false)
	Print url heading. More...
	url_print_intro ($url, $cm, $course, $ignoresettings=false)
	Print url introduction. More...
	url_print_workaround ($url, $cm, $course)
	Print url info and link. More...
	url_reset_userdata ($data)
	This function is used by the reset_course_userdata function in moodlelib. More...
	url_supports ($feature)
	List of features supported in URL module. More...
	url_update_instance ($data, $mform)
	Update url instance. More...
	url_view ($url, $course, $cm, $context)
	Mark the activity completed (if required) and trigger the course_module_viewed event. More...
	xmldb_url_install ()
	xmldb_url_upgrade ($oldversion)

Variables
	$capabilities
	$functions
	$logs
	$plugin = 2020060900
$plugin	component = 'mod_url'
$plugin	cron = 0
$plugin	version = 2020061500

Detailed Description

Function Documentation

mod_url_core_calendar_provide_event_action()

mod_url_core_calendar_provide_event_action	(	calendar_event	$event,
		core_calendar\action_factory	$factory,
			$userid = 0
	)

This function receives a calendar event and returns the action associated with it, or null if there is none.

This is used by block_myoverview in order to display the event appropriately. If null is returned then the event is not displayed on the block.

Parameters

calendar_event	$event
core_calendar::action_factory	$factory
int	$userid	ID override for calendar events

Return values

core_calendar::local::event::entities::action_interface|null

url_add_instance()

url_add_instance	(		$data,
			$mform
	)

Add url instance.

Parameters

object	$data
object	$mform

Return values

int	new url instance id

url_appears_valid_url()

url_appears_valid_url

(

$url

)

This methods does weak url validation, we are looking for major problems only, no strict RFE validation.

Parameters

$url

Return values

bool	true is seems valid, false if definitely not valid URL

url_check_updates_since()

url_check_updates_since	(	cm_info	$cm,
			$from,
			$filter = array()
	)

Check if the module has any update that affects the current user since a given time.

Parameters

cm_info	$cm	course module data
int	$from	the time to check updates from
array	$filter	if we need to check only specific updates

Return values

stdClass

an object with the different type of areas indicating if they were updated or not

Since

Moodle 3.2

url_delete_instance()

url_delete_instance

(

$id

)

Delete url instance.

Parameters

int

$id

Return values

bool

true

url_display_embed()

url_display_embed	(		$url,
			$cm,
			$course
	)

Display embedded url file.

Parameters

object	$url
object	$cm
object	$course

Return values

does	not return

url_display_frame()

url_display_frame	(		$url,
			$cm,
			$course
	)

Display url frames.

Parameters

object	$url
object	$cm
object	$course

Return values

does	not return

url_dndupload_handle()

url_dndupload_handle

(

$uploadinfo

)

Handle a file that has been uploaded.

Parameters

object

$uploadinfo

details of the file / content that has been uploaded

Return values

int	instance id of the newly created mod

url_dndupload_register()

url_dndupload_register

(

)

Register the ability to handle drag and drop file uploads.

Return values

array

containing details of the files / types the mod can handle

url_export_contents()

url_export_contents	(		$cm,
			$baseurl
	)

Export URL resource contents.

Return values

array

of file content

url_fix_submitted_url()

url_fix_submitted_url

(

$url

)

Fix common URL problems that we want teachers to see fixed the next time they edit the resource.

This function does not include any XSS protection.

Parameters

string

$url

Return values

string

url_get_coursemodule_info()

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

Return values

cached_cm_info

info

url_get_encrypted_parameter()

url_get_encrypted_parameter	(		$url,
			$config
	)

BC internal function.

Parameters

object	$url
object	$config

Return values

string

url_get_final_display_type()

url_get_final_display_type

(

$url

)

Decide the best display format.

Parameters

object

$url

Return values

int	display type constant

url_get_full_url()

url_get_full_url	(		$url,
			$cm,
			$course,
			$config = null
	)

Return full url with all extra parameters.

This function does not include any XSS protection.

Parameters

string	$url
object	$cm
object	$course
object	$config

Return values

string

url with & encoded as &

url_get_post_actions()

url_get_post_actions

(

)

List the actions that correspond to a post of this module.

This is used by the participation report.

Note: This is not used by new logging system. Event with crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING will be considered as post action.

Return values

array

url_get_variable_options()

url_get_variable_options

(

$config

)

Get the parameters that may be appended to URL.

Parameters

object

$config

url module config options

Return values

array

array describing opt groups

url_get_variable_values()

url_get_variable_values	(		$url,
			$cm,
			$course,
			$config
	)

Get the parameter values that may be appended to URL.

Parameters

object	$url	module instance
object	$cm
object	$course
object	$config	module config options

Return values

array

of parameter values

url_get_view_actions()

url_get_view_actions

(

)

List the actions that correspond to a view of this module.

This is used by the participation report.

Note: This is not used by new logging system. Event with crud = 'r' and edulevel = LEVEL_PARTICIPATING will be considered as view action.

Return values

array

url_guess_icon()

url_guess_icon	(		$fullurl,
			$size = null
	)

Optimised mimetype detection from general URL.

Parameters

	$fullurl
int	$size	of the icon.

Return values

string|null

mimetype or null when the filetype is not relevant.

url_page_type_list()

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

url_print_header()

url_print_header	(		$url,
			$cm,
			$course
	)

Print url header.

Parameters

object	$url
object	$cm
object	$course

Return values

void

url_print_heading()

url_print_heading	(		$url,
			$cm,
			$course,
			$notused = false
	)

Print url heading.

Parameters

object	$url
object	$cm
object	$course
bool	$notused	This variable is no longer used.

Return values

void

url_print_intro()

url_print_intro	(		$url,
			$cm,
			$course,
			$ignoresettings = false
	)

Print url introduction.

Parameters

object	$url
object	$cm
object	$course
bool	$ignoresettings	print even if not specified in modedit

Return values

void

url_print_workaround()

url_print_workaround	(		$url,
			$cm,
			$course
	)

Print url info and link.

Parameters

object	$url
object	$cm
object	$course

Return values

does	not return

url_reset_userdata()

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.

Return values

array

status array

url_supports()

url_supports

(

$feature

)

List of features supported in URL module.

Parameters

string

$feature

FEATURE_xx constant for requested feature

Return values

mixed

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

url_update_instance()

url_update_instance	(		$data,
			$mform
	)

Update url instance.

Parameters

object	$data
object	$mform

Return values

bool

true

url_view()

url_view	(		$url,
			$course,
			$cm,
			$context
	)

Mark the activity completed (if required) and trigger the course_module_viewed event.

Parameters

stdClass	$url	url object
stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object

Since

Moodle 3.0

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    'mod/url:view' => array(
        'captype' => 'read',
        'contextlevel' => CONTEXT_MODULE,
        'archetypes' => array(
            'guest' => CAP_ALLOW,
            'user' => CAP_ALLOW,
        )
    ),
 
    'mod/url:addinstance' => array(
        'riskbitmask' => RISK_XSS,
 
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'editingteacher' => CAP_ALLOW,
            'manager' => CAP_ALLOW
        ),
        'clonepermissionsfrom' => 'moodle/course:manageactivities'
    ),
 
 
 
)

$functions

$functions

Initial value:

= array(
 
    'mod_url_view_url' => array(
        'classname'     => 'mod_url_external',
        'methodname'    => 'view_url',
        'description'   => 'Trigger the course module viewed event and update the module completion status.',
        'type'          => 'write',
        'capabilities'  => 'mod/url:view',
        'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
    ),
    'mod_url_get_urls_by_courses' => array(
        'classname'     => 'mod_url_external',
        'methodname'    => 'get_urls_by_courses',
        'description'   => 'Returns a list of urls in a provided list of courses, if no list is provided all urls that the user
                            can view will be returned.',
        'type'          => 'read',
        'capabilities'  => 'mod/url:view',
        'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
    ),
)

$logs

$logs

Initial value:

= array(
    array('module'=>'url', 'action'=>'view', 'mtable'=>'url', 'field'=>'name'),
    array('module'=>'url', 'action'=>'view all', 'mtable'=>'url', 'field'=>'name'),
    array('module'=>'url', 'action'=>'update', 'mtable'=>'url', 'field'=>'name'),
    array('module'=>'url', 'action'=>'add', 'mtable'=>'url', 'field'=>'name'),
)