Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_workshop

Topics

 backup
 
 
 event
 
 
 external
 
 
 files
 
 
 grade
 
 
 log
 
 
 portfolio
 
 
 privacy
 
 
 test
 
 
 upgrade
 
 

Directories

directory analytics
  
 
directory backup
  
 

Namespaces

namespace  mod_workshop
  
 
namespace  mod_workshop\analytics\indicator
 Activity base class.
 
namespace  mod_workshop\event
 The mod_workshop assessable uploaded event.
 
namespace  mod_workshop\external
 Class for exporting assessment data.
 
namespace  mod_workshop\grades
  
 
namespace  mod_workshop\output
  
 
namespace  mod_workshop\plugininfo
 Subplugin info class.
 
namespace  mod_workshop\search
 Search area for mod_workshop activities.
 
namespace  mod_workshop\task
 A scheduled task for workshop cron.
 

Classes

class  mod_workshop\analytics\indicator\activity_base
 Activity base class. More...
 
class  mod_workshop\analytics\indicator\cognitive_depth
 Cognitive depth indicator - workshop. More...
 
class  mod_workshop\analytics\indicator\social_breadth
 Social breadth indicator - workshop. More...
 
class  mod_workshop\dates
 Class for fetching the important dates in mod_workshop for a given module instance and a user. More...
 
class  mod_workshop\event\assessable_uploaded
 The mod_workshop assessable uploaded event class. More...
 
class  mod_workshop\event\assessment_evaluated
 The mod_workshop assessment evaluated event class. More...
 
class  mod_workshop\event\assessment_reevaluated
 The mod_workshop assessment_reevaluated event class. More...
 
class  mod_workshop\event\course_module_instance_list_viewed
 The mod_workshop instance list viewed event class. More...
 
class  mod_workshop\event\course_module_viewed
 The mod_workshop course module viewed event class. More...
 
class  mod_workshop\event\phase_automatically_switched
 This event is triggered when a phase is automatically switched, usually from cron_task. More...
 
class  mod_workshop\event\submission_assessed
 The mod_workshop submission assessed event class. More...
 
class  mod_workshop\event\submission_created
 The mod_workshop submission created event class. More...
 
class  mod_workshop\event\submission_deleted
 The mod_workshop submission deleted event class. More...
 
class  mod_workshop\event\submission_reassessed
 The mod_workshop submission reassessed event class. More...
 
class  mod_workshop\event\submission_updated
 The mod_workshop submission updated event class. More...
 
class  mod_workshop\external\assessment_exporter
 Class for exporting assessment data. More...
 
class  mod_workshop\external\submission_exporter
 Class for exporting submission data. More...
 
class  mod_workshop\external\workshop_summary_exporter
 Class for exporting partial workshop data (some fields are only viewable by admins). More...
 
class  mod_workshop\grades\gradeitems
 Grade item mappings for the activity. More...
 
class  mod_workshop\output\actionbar
 Output the rendered elements for the tertiary nav for page action. More...
 
class  mod_workshop\plugininfo\workshopallocation
 
class  mod_workshop\plugininfo\workshopeval
 
class  mod_workshop\plugininfo\workshopform
 
class  mod_workshop\search\activity
 Search area for mod_workshop activities. More...
 
class  mod_workshop\task\cron_task
 The main scheduled task for the workshop. More...
 
class  mod_workshop_mod_form
 Module settings form for Workshop instances. More...
 
class  mod_workshop_renderer
 Workshop module renderer class. More...
 
class  moodle1_mod_workshop_handler
 Workshop conversion handler. More...
 
class  moodle1_workshopform_handler
 Base class for the grading strategy subplugin handler. More...
 
class  restore_workshop_activity_structure_step
 Define all the restore steps that will be used by the restore_workshop_activity_task. More...
 
class  restore_workshop_activity_task
 workshop restore task that provides all the settings and steps to perform one complete restore of the activity More...
 
class  workshop
 Full-featured workshop API. More...
 
class  workshop_allocation_result
 Stores the information about the allocation process. More...
 
interface  workshop_allocator
 Allocators are responsible for assigning submissions to reviewers for assessments. More...
 
class  workshop_assessment
 Represents a rendarable full assessment. More...
 
class  workshop_assessment_base
 Common base class for assessments rendering. More...
 
class  workshop_assessment_form
 Base class for all assessment forms. More...
 
class  workshop_edit_strategy_form
 Base class for editing all the strategy grading forms. More...
 
class  workshop_evaluation
 Base class for all grading evaluation subplugins. More...
 
class  workshop_evaluation_settings_form
 Base form to hold eventual evaluation settings. More...
 
class  workshop_example_assessment
 Represents a renderable training assessment of an example submission. More...
 
class  workshop_example_reference_assessment
 Represents a renderable reference assessment of an example submission. More...
 
class  workshop_example_submission
 Renderable object containing all the information needed to display the example submission. More...
 
class  workshop_example_submission_summary
 Renderable object containing a basic set of information needed to display the example submission summary. More...
 
class  workshop_feedback
 Base class for renderable feedback for author and feedback for reviewer. More...
 
class  workshop_feedback_author
 Renderable feedback for the author of submission. More...
 
class  workshop_feedback_reviewer
 Renderable feedback for the reviewer. More...
 
class  workshop_feedbackauthor_form
 
class  workshop_feedbackreviewer_form
 
class  workshop_final_grades
 Holds the final grades for the activity as are stored in the gradebook. More...
 
class  workshop_grading_report
 Renderable component containing all the data needed to display the grading report. More...
 
class  workshop_message
 Renderable message to be displayed to the user. More...
 
interface  workshop_strategy
 Strategy interface defines all methods that strategy subplugins has to implement. More...
 
class  workshop_submission
 Renderable object containing all the information needed to display the submission. More...
 
class  workshop_submission_base
 Common base class for submissions and example submissions rendering. More...
 
class  workshop_submission_form
 
class  workshop_submission_summary
 Renderable object containing a basic set of information needed to display the submission summary. More...
 
class  workshop_user_plan
 Represents the user planner tool. More...
 

Functions

 mod_workshop_uninstall ()
 This is called at the beginning of the uninstallation process to give the module a chance to clean-up its hacks, bits etc.
 
 workshop_upgrade_transform_instance (stdClass $old)
 Given a record containing data from 1.9 workshop table, returns object containing data as should be saved in 2.0 workshop table.
 

Variables

 $capabilities
 
global mod_workshop\event::$CFG
 
 $plugin = 2023100400
 
 $tasks
 
$plugin component = 'mod_workshop'
 
$plugin version = 2023100900
 

Detailed Description

Function Documentation

◆ mod_workshop_uninstall()

mod_workshop_uninstall ( )

This is called at the beginning of the uninstallation process to give the module a chance to clean-up its hacks, bits etc.

where possible.

Return values
booltrue if success

◆ workshop_upgrade_transform_instance()

workshop_upgrade_transform_instance ( stdClass $old)

Given a record containing data from 1.9 workshop table, returns object containing data as should be saved in 2.0 workshop table.

Parameters
stdClass$oldrecord from 1.9 workshop table
Return values
stdClass

Variable Documentation

◆ $tasks

$tasks
Initial value:
= [
[
'classname' => '\mod_workshop\task\cron_task',
'blocking' => 0,
'minute' => '*',
'hour' => '*',
'day' => '*',
'month' => '*',
'dayofweek' => '*'
]
]