Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
mod_resource

Namespaces

namespace  mod_resource\analytics\indicator
  
 
namespace  mod_resource\completion
  
 
namespace  mod_resource\content
  
 
namespace  mod_resource\event
  
 
namespace  mod_resource\output\courseformat
  
 
namespace  mod_resource\privacy
  
 
namespace  mod_resource\search
  
 

Classes

class  backup_resource_activity_structure_step
 Define the complete resource structure for backup, with file and id annotations. More...
 
class  backup_resource_activity_task
 Provides the steps to perform one complete backup of the Resource instance. More...
 
class  mod_resource\analytics\indicator\activity_base
 Activity base class. More...
 
class  mod_resource\analytics\indicator\cognitive_depth
 Cognitive depth indicator - resource. More...
 
class  mod_resource\analytics\indicator\social_breadth
 Social breadth indicator - resource. More...
 
class  mod_resource\completion\custom_completion
 
class  mod_resource\content\exporter
 A class which assists a component to export content. More...
 
class  mod_resource\event\course_module_instance_list_viewed
 The mod_resource instance list viewed event class. More...
 
class  mod_resource\event\course_module_viewed
 The mod_resource course module viewed event class. More...
 
class  mod_resource\output\courseformat\activitybadge
 
class  mod_resource\privacy\provider
 The mod_resource module does not store any data. More...
 
class  mod_resource\search\activity
 Search area for mod_resource activities. More...
 
class  mod_resource_external
 
class  mod_resource_generator
 Resource module data generator class. More...
 
class  mod_resource_mod_form
 
class  moodle1_mod_resource_handler
 Resource conversion handler. More...
 
class  resource_content_file_info
 File browsing support class. More...
 
class  restore_resource_activity_structure_step
 Define all the restore steps that will be used by the restore_resource_activity_task. More...
 
class  restore_resource_activity_task
 resource restore task that provides all the settings and steps to perform one complete restore of the activity More...
 

Functions

 mod_resource_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.
 
 mod_resource_get_path_from_pluginfile (string $filearea, array $args)
 Given an array with a file path, it returns the itemid and the filepath for the defined filearea.
 
 resource_add_instance ($data, $mform)
 Add resource instance.
 
 resource_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.
 
 resource_cm_info_view (cm_info $cm)
 Called when viewing course page.
 
 resource_delete_instance ($id)
 Delete resource instance.
 
 resource_display_embed ($resource, $cm, $course, $file)
 Display embedded resource file.
 
 resource_display_frame ($resource, $cm, $course, $file)
 Display resource frames.
 
 resource_dndupload_handle ($uploadinfo)
 Handle a file that has been uploaded.
 
 resource_dndupload_register ()
 Register the ability to handle drag and drop file uploads.
 
 resource_export_contents ($cm, $baseurl)
 Export file resource contents.
 
 resource_get_clicktodownload ($file, $revision)
 Internal function - create click to open text with link.
 
 resource_get_clicktoopen ($file, $revision, $extra='')
 Internal function - create click to open text with link.
 
 resource_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.
 
 resource_get_file_areas ($course, $cm, $context)
 Lists all browsable file areas.
 
 resource_get_file_details ($resource, $cm)
 Gets details of the file to cache in course cache to be displayed using resource_get_optional_details().
 
 resource_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
 File browsing support for resource module content area.
 
 resource_get_final_display_type ($resource)
 Decide the best display format.
 
 resource_get_intro (object $resource, object $cm, bool $ignoresettings=false)
 Get resource introduction.
 
 resource_get_optional_details ($resource, $cm, bool $showtype=true)
 Gets optional details for a resource, depending on resource settings.
 
 resource_get_optional_filetype ($resource, $cm)
 Gets optional file type extension for a resource, depending on resource settings.
 
 resource_get_post_actions ()
 List the actions that correspond to a post of this module.
 
 resource_get_view_actions ()
 List the actions that correspond to a view of this module.
 
 resource_page_type_list ($pagetype, $parentcontext, $currentcontext)
 Return a list of page types.
 
 resource_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
 Serves the resource files.
 
 resource_print_filenotfound ($resource, $cm, $course)
 Print warning that file can not be found.
 
 resource_print_header ($resource, $cm, $course)
 Print resource header.
 
 resource_print_heading ($resource, $cm, $course, $notused=false)
 Print resource heading.
 
 resource_print_intro ($resource, $cm, $course, $ignoresettings=false)
 Print resource introduction.
 
 resource_print_tobemigrated ($resource, $cm, $course)
 Print warning that instance not migrated yet.
 
 resource_print_workaround ($resource, $cm, $course, $file)
 Print resource info and workaround link when JS not available.
 
 resource_redirect_if_migrated ($oldid, $cmid)
 Redirected to migrated resource if needed, return if incorrect parameters specified.
 
 resource_reset_userdata ($data)
 This function is used by the reset_course_userdata function in moodlelib.
 
 resource_set_display_options ($data)
 Updates display options based on form input.
 
 resource_set_mainfile ($data)
 
 resource_supports ($feature)
 List of features supported in Resource module.
 
 resource_update_instance ($data, $mform)
 Update resource instance.
 
 resource_view ($resource, $course, $cm, $context)
 Mark the activity completed (if required) and trigger the course_module_viewed event.
 
 xmldb_resource_upgrade ($oldversion)
 

Variables

 $capabilities
 
 $functions
 
 $logs
 
 $plugin = 2024041600
 
$plugin component = 'mod_resource'
 
$plugin cron = 0
 
$plugin version = 2024042200
 

Detailed Description

Function Documentation

◆ mod_resource_core_calendar_provide_event_action()

mod_resource_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
Return values
core_calendar\local\event\entities\action_interface|null

◆ mod_resource_get_path_from_pluginfile()

mod_resource_get_path_from_pluginfile ( string $filearea,
array $args )

Given an array with a file path, it returns the itemid and the filepath for the defined filearea.

Parameters
string$fileareaThe filearea.
array$argsThe path (the part after the filearea and before the filename).
Return values
arrayThe itemid and the filepath inside the $args path, for the defined filearea.

◆ resource_add_instance()

resource_add_instance ( $data,
$mform )

Add resource instance.

Parameters
object$data
object$mform
Return values
intnew resource instance id

◆ resource_check_updates_since()

resource_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$cmcourse module data
int$fromthe time to check updates from
array$filterif we need to check only specific updates
Return values
stdClassan object with the different type of areas indicating if they were updated or not
Since
Moodle 3.2

◆ resource_cm_info_view()

resource_cm_info_view ( cm_info $cm)

Called when viewing course page.

Shows extra details after the link if enabled.

Parameters
cm_info$cmCourse module information

◆ resource_delete_instance()

resource_delete_instance ( $id)

Delete resource instance.

Parameters
int$id
Return values
booltrue

◆ resource_display_embed()

resource_display_embed ( $resource,
$cm,
$course,
$file )

Display embedded resource file.

Parameters
object$resource
object$cm
object$course
stored_file$filemain file
Return values
doesnot return

◆ resource_display_frame()

resource_display_frame ( $resource,
$cm,
$course,
$file )

Display resource frames.

Parameters
object$resource
object$cm
object$course
stored_file$filemain file
Return values
doesnot return

◆ resource_dndupload_handle()

resource_dndupload_handle ( $uploadinfo)

Handle a file that has been uploaded.

Parameters
object$uploadinfodetails of the file / content that has been uploaded
Return values
intinstance id of the newly created mod

◆ resource_dndupload_register()

resource_dndupload_register ( )

Register the ability to handle drag and drop file uploads.

Return values
arraycontaining details of the files / types the mod can handle

◆ resource_export_contents()

resource_export_contents ( $cm,
$baseurl )

Export file resource contents.

Return values
arrayof file content

◆ resource_get_coursemodule_info()

resource_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 course_modinfo::get_array_of_activities()

Parameters
stdClass$coursemodule
Return values
cached_cm_infoinfo

◆ resource_get_file_areas()

resource_get_file_areas ( $course,
$cm,
$context )

Lists all browsable file areas.

Parameters
stdClass$coursecourse object
stdClass$cmcourse module object
stdClass$contextcontext object
Return values
array

◆ resource_get_file_details()

resource_get_file_details ( $resource,
$cm )

Gets details of the file to cache in course cache to be displayed using resource_get_optional_details().

Parameters
object$resourceResource table row (only property 'displayoptions' is used here)
object$cmCourse-module table row
Return values
stringSize and type or empty string if show options are not enabled

◆ resource_get_file_info()

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

File browsing support for resource module content area.

Parameters
file_browser$browserfile browser instance
stdClass$areasfile areas
stdClass$coursecourse object
stdClass$cmcourse module object
stdClass$contextcontext object
string$fileareafile area
int$itemiditem ID
string$filepathfile path
string$filenamefile name
Return values
file_infoinstance or null if not found

◆ resource_get_final_display_type()

resource_get_final_display_type ( $resource)

Decide the best display format.

Parameters
object$resource
Return values
intdisplay type constant

◆ resource_get_intro()

resource_get_intro ( object $resource,
object $cm,
bool $ignoresettings = false )

Get resource introduction.

Parameters
object$resource
object$cm
bool$ignoresettingsprint even if not specified in modedit
Return values
string

◆ resource_get_optional_details()

resource_get_optional_details ( $resource,
$cm,
bool $showtype = true )

Gets optional details for a resource, depending on resource settings.

Result may include the file size and type if those settings are chosen, or blank if none.

Parameters
object$resourceResource table row (only property 'displayoptions' is used here)
object$cmCourse-module table row
bool$showtypeWhether the file type should be displayed or not (regardless the display option is enabled).
Return values
stringSize and type or empty string if show options are not enabled

◆ resource_get_optional_filetype()

resource_get_optional_filetype ( $resource,
$cm )

Gets optional file type extension for a resource, depending on resource settings.

Parameters
object$resourceResource table row (only property 'displayoptions' is used here)
object$cmCourse-module table row
Return values
stringFile extension or null if showtype option is not enabled

◆ resource_get_post_actions()

resource_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

◆ resource_get_view_actions()

resource_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

◆ resource_page_type_list()

resource_page_type_list ( $pagetype,
$parentcontext,
$currentcontext )

Return a list of page types.

Parameters
string$pagetypecurrent page type
stdClass$parentcontextBlock's parent context
stdClass$currentcontextCurrent context of block

◆ resource_pluginfile()

resource_pluginfile ( $course,
$cm,
$context,
$filearea,
$args,
$forcedownload,
array $options = array() )

Serves the resource files.

Parameters
stdClass$coursecourse object
stdClass$cmcourse module object
stdClass$contextcontext object
string$fileareafile area
array$argsextra arguments
bool$forcedownloadwhether or not force download
array$optionsadditional options affecting the file serving
Return values
boolfalse if file not found, does not return if found - just send the file

◆ resource_print_filenotfound()

resource_print_filenotfound ( $resource,
$cm,
$course )

Print warning that file can not be found.

Parameters
object$resource
object$cm
object$course
Return values
void,doesnot return

◆ resource_print_header()

resource_print_header ( $resource,
$cm,
$course )

Print resource header.

Parameters
object$resource
object$cm
object$course
Return values
void

◆ resource_print_heading()

resource_print_heading ( $resource,
$cm,
$course,
$notused = false )

Print resource heading.

Deprecated
since Moodle 4.0
Parameters
object$resource
object$cm
object$course
bool$notusedThis variable is no longer used
Return values
void

◆ resource_print_intro()

resource_print_intro ( $resource,
$cm,
$course,
$ignoresettings = false )

Print resource introduction.

Deprecated
since Moodle 4.0
Parameters
object$resource
object$cm
object$course
bool$ignoresettingsprint even if not specified in modedit
Return values
void

◆ resource_print_tobemigrated()

resource_print_tobemigrated ( $resource,
$cm,
$course )

Print warning that instance not migrated yet.

Parameters
object$resource
object$cm
object$course
Return values
void,doesnot return

◆ resource_print_workaround()

resource_print_workaround ( $resource,
$cm,
$course,
$file )

Print resource info and workaround link when JS not available.

Parameters
object$resource
object$cm
object$course
stored_file$filemain file
Return values
doesnot return

◆ resource_redirect_if_migrated()

resource_redirect_if_migrated ( $oldid,
$cmid )

Redirected to migrated resource if needed, return if incorrect parameters specified.

Parameters
int$oldid
int$cmid
Return values
void

◆ resource_reset_userdata()

resource_reset_userdata ( $data)

This function is used by the reset_course_userdata function in moodlelib.

Parameters
$datathe data submitted from the reset course.
Return values
arraystatus array

◆ resource_set_display_options()

resource_set_display_options ( $data)

Updates display options based on form input.

Shared code used by resource_add_instance and resource_update_instance.

Parameters
object$dataData object

◆ resource_supports()

resource_supports ( $feature)

List of features supported in Resource module.

Parameters
string$featureFEATURE_xx constant for requested feature
Return values
mixedTrue if module supports feature, false if not, null if doesn't know or string for the module purpose.

◆ resource_update_instance()

resource_update_instance ( $data,
$mform )

Update resource instance.

Parameters
object$data
object$mform
Return values
booltrue

◆ resource_view()

resource_view ( $resource,
$course,
$cm,
$context )

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

Parameters
stdClass$resourceresource object
stdClass$coursecourse object
stdClass$cmcourse module object
stdClass$contextcontext object
Since
Moodle 3.0

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'mod/resource:view' => array(
'captype' => 'read',
'contextlevel' => CONTEXT_MODULE,
'archetypes' => array(
'guest' => CAP_ALLOW,
'user' => CAP_ALLOW,
)
),
'mod/resource:addinstance' => array(
'riskbitmask' => RISK_XSS,
'captype' => 'write',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => array(
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW
),
'clonepermissionsfrom' => 'moodle/course:manageactivities'
),
)
const CONTEXT_COURSE
Course context level - one instances for each course.
Definition accesslib.php:128
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition accesslib.php:115
const RISK_XSS
Capability allows user to add scripted content - see
Definition accesslib.php:143
const CONTEXT_MODULE
Course module context level - one instance for each course module.
Definition accesslib.php:130

◆ $functions

$functions
Initial value:
= array(
'mod_resource_view_resource' => array(
'classname' => 'mod_resource_external',
'methodname' => 'view_resource',
'description' => 'Simulate the view.php web interface resource: trigger events, completion, etc...',
'type' => 'write',
'capabilities' => 'mod/resource:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_resource_get_resources_by_courses' => array(
'classname' => 'mod_resource_external',
'methodname' => 'get_resources_by_courses',
'description' => 'Returns a list of files in a provided list of courses, if no list is provided all files that
the user can view will be returned.',
'type' => 'read',
'capabilities' => 'mod/resource:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
)
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:555

◆ $logs

$logs
Initial value:
= array(
array('module'=>'resource', 'action'=>'view', 'mtable'=>'resource', 'field'=>'name'),
array('module'=>'resource', 'action'=>'view all', 'mtable'=>'resource', 'field'=>'name'),
array('module'=>'resource', 'action'=>'update', 'mtable'=>'resource', 'field'=>'name'),
array('module'=>'resource', 'action'=>'add', 'mtable'=>'resource', 'field'=>'name'),
)