Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
lib.php File Reference

Functions

 mod_workshop_core_calendar_event_timestart_updated (\calendar_event $event, stdClass $workshop)
 This function will update the workshop module according to the event that has been modified.
 
 mod_workshop_core_calendar_get_event_action_string ($eventtype)
 Callback to fetch the activity event type lang string.
 
 mod_workshop_core_calendar_get_valid_event_timestart_range (\calendar_event $event, stdClass $workshop)
 This function calculates the minimum and maximum cutoff values for the timestart of the given event.
 
 mod_workshop_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, int $userid=0)
 This function receives a calendar event and returns the action associated with it, or null if there is none.
 
 mod_workshop_get_fontawesome_icon_map ()
 Get icon mapping for font-awesome.
 
 mod_workshop_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.
 
 mod_workshop_user_preferences ()
 Get the current user preferences that are available.
 
 workshop_add_instance (stdclass $workshop)
 Saves a new instance of the workshop into the database.
 
 workshop_calendar_update (stdClass $workshop, $cmid)
 Updates the calendar events associated to the given workshop.
 
 workshop_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.
 
 workshop_delete_instance ($id)
 Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.
 
 workshop_extend_navigation (navigation_node $navref, stdclass $course, stdclass $module, cm_info $cm)
 Extends the global navigation tree by adding workshop nodes if there is a relevant content.
 
 workshop_extend_settings_navigation (settings_navigation $settingsnav, navigation_node $workshopnode=null)
 Extends the settings navigation with the Workshop settings.
 
 workshop_get_coursemodule_info ($coursemodule)
 Add a get_coursemodule_info function in case any feedback type wants to add 'extra' information for the course (see resource).
 
 workshop_get_file_areas ($course, $cm, $context)
 Returns the lists of all browsable file areas within the given module context.
 
 workshop_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
 File browsing support for workshop file areas.
 
 workshop_get_post_actions ()
 List the actions that correspond to a post of this module.
 
 workshop_get_recent_mod_activity (&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)
 Returns all activity in course workshops since a given time.
 
 workshop_get_view_actions ()
 List the actions that correspond to a view of this module.
 
 workshop_grade_item_category_update ($workshop)
 Update the grade items categories if they are changed via mod_form.php.
 
 workshop_grade_item_update (stdclass $workshop, $submissiongrades=null, $assessmentgrades=null)
 Creates or updates grade items for the give workshop instance.
 
 workshop_page_type_list ($pagetype, $parentcontext, $currentcontext)
 Return a list of page types.
 
 workshop_pluginfile ($course, $cm, $context, $filearea, array $args, $forcedownload, array $options=array())
 Serves the files from the workshop file areas.
 
 workshop_print_recent_activity ($course, $viewfullnames, $timestart)
 Given a course and a time, this module should find recent activity that has occurred in workshop activities and print it out.
 
 workshop_print_recent_mod_activity ($activity, $courseid, $detail, $modnames, $viewfullnames)
 Print single activity item prepared by {.
 
 workshop_refresh_events ($courseid=0, $instance=null, $cm=null)
 This standard function will check all instances of this module and make sure there are up-to-date events created for each of them.
 
 workshop_reset_course_form_defaults (stdClass $course)
 Provides default values for the workshop settings in the course reset form.
 
 workshop_reset_course_form_definition ($mform)
 Extends the course reset form with workshop specific settings.
 
 workshop_reset_userdata (stdClass $data)
 Performs the reset of all workshop instances in the course.
 
 workshop_scale_used ()
 
 workshop_scale_used_anywhere ($scaleid)
 Is a given scale used by any instance of workshop?
 
 workshop_supports ($feature)
 Returns the information if the module supports a feature.
 
 workshop_update_grades (stdclass $workshop, $userid=0)
 Update workshop grades in the gradebook.
 
 workshop_update_instance (stdclass $workshop)
 Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will update an existing instance with new data.
 
 workshop_user_complete ($course, $user, $mod, $workshop)
 Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports.
 
 workshop_user_outline ($course, $user, $mod, $workshop)
 Return a small object with summary information about what a user has done with a given particular instance of this module Used for user activity reports.
 

Variables

const WORKSHOP_EVENT_TYPE_ASSESSMENT_CLOSE 'closeassessment'
 
const WORKSHOP_EVENT_TYPE_ASSESSMENT_OPEN 'openassessment'
 
const WORKSHOP_EVENT_TYPE_SUBMISSION_CLOSE 'closesubmission'
 
const WORKSHOP_EVENT_TYPE_SUBMISSION_OPEN 'opensubmission'
 
const WORKSHOP_SUBMISSION_TYPE_AVAILABLE 1
 
const WORKSHOP_SUBMISSION_TYPE_DISABLED 0
 
const WORKSHOP_SUBMISSION_TYPE_REQUIRED 2