Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250711) (9addea9f0ac)
|
library class for onlinetext submission plugin extending submission plugin base class More...
Public Member Functions | |
add_attempt (stdClass $oldsubmission, stdClass $newsubmission) | |
Carry out any extra processing required when a student is given a new attempt (i.e. | |
allow_image_conversion () | |
Determine if the plugin allows image file conversion. | |
allow_submissions () | |
This plugin accepts submissions from a student The comments plugin has no submission component so should not be counted when determining whether to show the edit submission link. | |
can_upgrade ($type, $version) | |
Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version. | |
check_word_count ($submissiontext) | |
Compare word count of onlinetext submission to word limit, and return result. | |
copy_submission (stdClass $sourcesubmission, stdClass $destsubmission) | |
Copy the student's submission from a previous submission. | |
data_preprocessing (&$defaultvalues) | |
Allows the plugin to update the defaultvalues passed in to the settings form (needed to set up draft areas for editor and filemanager elements) | |
delete_instance () | |
The assignment has been deleted - cleanup. | |
disable () | |
Set this plugin to disabled. | |
enable () | |
Set this plugin to enabled. | |
get_config ($setting=null) | |
Get a configuration value for this plugin. | |
get_config_file_areas () | |
Get a list of file areas associated with the plugin configuration. | |
get_config_for_external () | |
Return the plugin configs for external functions. | |
get_editor_fields () | |
Return a list of the text fields that can be imported/exported by this plugin. | |
get_editor_format ($name, $submissionid) | |
Get the content format for the editor. | |
get_editor_text ($name, $submissionid) | |
Get the saved text content from the editor. | |
get_error () | |
What was the last error? | |
get_external_parameters () | |
Return a description of external params suitable for uploading an onlinetext submission from a webservice. | |
get_file_areas () | |
Get file areas returns a list of areas this plugin stores files. | |
get_file_info ($browser, $filearea, $itemid, $filepath, $filename) | |
Default implementation of file_get_info for plugins. | |
get_files (stdClass $submission, stdClass $user) | |
Produce a list of files suitable for export that represent this submission. | |
get_form_elements ($submission, MoodleQuickForm $mform, stdClass $data) | |
Add form elements for settings. | |
get_form_elements_for_user ($submissionorgrade, MoodleQuickForm $mform, stdClass $data, $userid) | |
Get any additional fields for the submission/grading form for this assignment. | |
get_name () | |
Get the name of the online text submission plugin. | |
get_requires () | |
Get the required moodle version for this plugin. | |
get_settings (MoodleQuickForm $mform) | |
Get the settings for onlinetext submission plugin. | |
get_sort_order () | |
Get the numerical sort order for this plugin. | |
get_subtype () | |
return subtype name of the plugin | |
get_type () | |
Should return the type of this plugin. | |
get_version () | |
Get the installed version of this plugin. | |
has_admin_settings () | |
Has this plugin got a custom settings.php file? | |
has_user_summary () | |
If this plugin should not include a column in the grading table or a row on the summary page then return false. | |
is_configurable () | |
If true, the plugin will appear on the module settings page and can be enabled/disabled per assignment instance. | |
is_empty (stdClass $submission) | |
No text is set for this plugin. | |
is_enabled () | |
Allows hiding this plugin from the submission/feedback screen if it is not enabled. | |
is_first () | |
Is this the first plugin in the list? | |
is_last () | |
Is this the last plugin in the list? | |
is_visible () | |
Is this plugin enaled? | |
lock ($submission, stdClass $flags) | |
Carry out any extra processing required when the work is locked. | |
precheck_submission ($submission) | |
Check if the submission plugin has all the required data to allow the work to be submitted for grading. | |
remove (stdClass $submission) | |
Remove a submission. | |
revert_to_draft (stdClass $submission) | |
Carry out any extra processing required when the work reverted to draft. | |
save (stdClass $submission, stdClass $data) | |
Save data to the database and trigger plagiarism plugin, if enabled, to scan the uploaded content via events trigger. | |
save_settings (stdClass $data) | |
Save the settings for onlinetext submission plugin. | |
set_config ($name, $value) | |
Set a configuration value for this plugin. | |
set_editor_format ($name, $format, $submissionorgradeid) | |
Given a field name and value should update the format for this field in the plugins submission or grade. | |
set_editor_text ($name, $value, $submissionorgradeid) | |
Given a field name and value should update the text for this field in the plugins submission or grade. | |
settings_validation (array $data, array $files) | |
This method is called when the mod_assign_mod_form is submitted. | |
submission_is_empty (stdClass $data) | |
Determine if a submission is empty. | |
submission_summary_for_messages (stdClass $submission) | |
Summarise a submission for inclusion in messages. | |
submit_for_grading ($submission) | |
Carry out any extra processing required when the work is submitted for grading. | |
unlock ($submission, stdClass $flags) | |
Carry out any extra processing required when the work is unlocked. | |
upgrade (context $oldcontext, stdClass $oldassignment, stdClass $oldsubmission, stdClass $submission, & $log) | |
Upgrade the submission from the old assignment to the new one. | |
upgrade_settings (context $oldcontext, stdClass $oldassignment, & $log) | |
Upgrade the settings from the old assignment to the new plugin based one. | |
view (stdClass $submission) | |
Display the saved text content from the editor in the view table. | |
view_header () | |
This allows a plugin to render an introductory section which is displayed right below the activity's "intro" section on the main assignment page. | |
view_page ($action) | |
This allows a plugin to render a page in the context of the assignment. | |
view_summary (stdClass $submission, & $showviewlink) | |
Display onlinetext word count in the submission status table. | |
Static Public Member Functions | |
static | cron () |
Run cron for this plugin. | |
Protected Member Functions | |
set_error ($msg) | |
Save the error message from the last error. | |
Protected Attributes | |
assign | $assignment |
$assignment the assignment record that contains the global settings for this assign instance | |
library class for onlinetext submission plugin extending submission plugin base class
|
inherited |
Carry out any extra processing required when a student is given a new attempt (i.e.
when the submission is "reopened"
stdClass | $oldsubmission | The previous attempt |
stdClass | $newsubmission | The new attempt |
|
inherited |
Determine if the plugin allows image file conversion.
bool |
Reimplemented in assign_submission_file.
|
inherited |
This plugin accepts submissions from a student The comments plugin has no submission component so should not be counted when determining whether to show the edit submission link.
boolean |
Reimplemented in assign_submission_comments.
assign_submission_onlinetext::can_upgrade | ( | $type, | |
$version ) |
Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version.
string | $type | old assignment subtype |
int | $version | old assignment version |
bool | True if upgrade is possible |
Reimplemented from assign_plugin.
assign_submission_onlinetext::check_word_count | ( | $submissiontext | ) |
Compare word count of onlinetext submission to word limit, and return result.
string | $submissiontext | Onlinetext submission text from editor |
string | Error message if limit is enabled and exceeded, otherwise null |
assign_submission_onlinetext::copy_submission | ( | stdClass | $sourcesubmission, |
stdClass | $destsubmission ) |
Copy the student's submission from a previous submission.
Used when a student opts to base their resubmission on the last submission.
stdClass | $sourcesubmission | |
stdClass | $destsubmission |
Reimplemented from assign_submission_plugin.
|
inherited |
Allows the plugin to update the defaultvalues passed in to the settings form (needed to set up draft areas for editor and filemanager elements)
array | $defaultvalues |
assign_submission_onlinetext::delete_instance | ( | ) |
|
finalinherited |
Set this plugin to disabled.
bool |
|
finalinherited |
Set this plugin to enabled.
bool |
|
finalinherited |
Get a configuration value for this plugin.
mixed | $setting | The config key (string) or null |
mixed | string | false |
|
inherited |
Get a list of file areas associated with the plugin configuration.
This is used for backup/restore.
array | names of the fileareas, can be an empty array |
assign_submission_onlinetext::get_config_for_external | ( | ) |
Return the plugin configs for external functions.
array | the list of settings |
Reimplemented from assign_plugin.
assign_submission_onlinetext::get_editor_fields | ( | ) |
Return a list of the text fields that can be imported/exported by this plugin.
array | An array of field names and descriptions. (name=>description, ...) |
Reimplemented from assign_plugin.
assign_submission_onlinetext::get_editor_format | ( | $name, | |
$submissionid ) |
Get the content format for the editor.
string | $name | |
int | $submissionid |
int |
Reimplemented from assign_plugin.
assign_submission_onlinetext::get_editor_text | ( | $name, | |
$submissionid ) |
Get the saved text content from the editor.
string | $name | |
int | $submissionid |
string |
Reimplemented from assign_plugin.
|
finalinherited |
What was the last error?
string |
assign_submission_onlinetext::get_external_parameters | ( | ) |
Return a description of external params suitable for uploading an onlinetext submission from a webservice.
core_external::external_description|null |
Reimplemented from assign_plugin.
assign_submission_onlinetext::get_file_areas | ( | ) |
Get file areas returns a list of areas this plugin stores files.
array | - An array of fileareas (keys) and descriptions (values) |
Reimplemented from assign_plugin.
|
inherited |
Default implementation of file_get_info for plugins.
This is used by the filebrowser to browse a plugins file areas.
This implementation should work for most plugins but can be overridden if required.
file_browser | $browser | |
string | $filearea | |
int | $itemid | |
string | $filepath | |
string | $filename |
file_info_stored |
assign_submission_onlinetext::get_files | ( | stdClass | $submission, |
stdClass | $user ) |
Produce a list of files suitable for export that represent this submission.
stdClass | $submission | - For this is the submission data |
stdClass | $user | - This is the user record for this submission |
array | - return an array of files indexed by filename |
Reimplemented from assign_plugin.
assign_submission_onlinetext::get_form_elements | ( | $submission, | |
MoodleQuickForm | $mform, | ||
stdClass | $data ) |
Add form elements for settings.
mixed | $submission | can be null |
MoodleQuickForm | $mform | |
stdClass | $data |
true | if elements were added to the form |
Reimplemented from assign_plugin.
|
inherited |
Get any additional fields for the submission/grading form for this assignment.
mixed | $submissionorgrade | submission|grade - For submission plugins this is the submission data, for feedback plugins it is the grade data |
MoodleQuickForm | $mform | - This is the form |
stdClass | $data | - This is the form data that can be modified for example by a filemanager element |
int | $userid | - This is the userid for the current submission. This is passed separately as there may not yet be a submission or grade. |
boolean | - true if we added anything to the form |
Reimplemented in assign_feedback_comments, assign_feedback_editpdf, and assign_feedback_file.
assign_submission_onlinetext::get_name | ( | ) |
Get the name of the online text submission plugin.
string |
Reimplemented from assign_plugin.
|
finalinherited |
Get the required moodle version for this plugin.
string |
assign_submission_onlinetext::get_settings | ( | MoodleQuickForm | $mform | ) |
Get the settings for onlinetext submission plugin.
MoodleQuickForm | $mform | The form to add elements to |
void |
Reimplemented from assign_plugin.
|
finalinherited |
Get the numerical sort order for this plugin.
int |
|
finalinherited |
|
finalinherited |
Should return the type of this plugin.
string | - the type |
|
finalinherited |
Get the installed version of this plugin.
string |
|
finalinherited |
Has this plugin got a custom settings.php file?
bool |
|
inherited |
If this plugin should not include a column in the grading table or a row on the summary page then return false.
bool |
Reimplemented in assign_feedback_offline.
|
inherited |
If true, the plugin will appear on the module settings page and can be enabled/disabled per assignment instance.
bool |
Reimplemented in assign_feedback_editpdf, and assign_submission_comments.
assign_submission_onlinetext::is_empty | ( | stdClass | $submission | ) |
No text is set for this plugin.
stdClass | $submission |
bool |
Reimplemented from assign_plugin.
|
inherited |
Allows hiding this plugin from the submission/feedback screen if it is not enabled.
bool | - if false - this plugin will not accept submissions / feedback |
Reimplemented in assign_feedback_offline, and assign_submission_comments.
|
finalinherited |
Is this the first plugin in the list?
bool |
|
finalinherited |
Is this the last plugin in the list?
bool |
|
finalinherited |
Is this plugin enaled?
bool |
|
inherited |
Carry out any extra processing required when the work is locked.
stdClass | false | $submission | - assign_submission data if any |
stdClass | $flags | - User flags record |
void |
|
inherited |
Check if the submission plugin has all the required data to allow the work to be submitted for grading.
stdClass | $submission | the assign_submission record being submitted. |
bool|string | 'true' if OK to proceed with submission, otherwise a a message to display to the user |
assign_submission_onlinetext::remove | ( | stdClass | $submission | ) |
Remove a submission.
stdClass | $submission | The submission |
boolean |
Reimplemented from assign_submission_plugin.
|
inherited |
Carry out any extra processing required when the work reverted to draft.
stdClass | $submission | - assign_submission data |
void |
assign_submission_onlinetext::save | ( | stdClass | $submission, |
stdClass | $data ) |
Save data to the database and trigger plagiarism plugin, if enabled, to scan the uploaded content via events trigger.
stdClass | $submission | |
stdClass | $data |
bool |
Reimplemented from assign_plugin.
assign_submission_onlinetext::save_settings | ( | stdClass | $data | ) |
Save the settings for onlinetext submission plugin.
stdClass | $data |
bool |
Reimplemented from assign_plugin.
|
finalinherited |
Set a configuration value for this plugin.
string | $name | The config key |
string | $value | The config value |
bool |
|
inherited |
Given a field name and value should update the format for this field in the plugins submission or grade.
string | $name | Name of the field. |
int | $format | Updated format. |
int | $submissionorgradeid | The id of the submission or grade. |
bool | - true if the value was updated |
|
inherited |
Given a field name and value should update the text for this field in the plugins submission or grade.
string | $name | Name of the field. |
string | $value | Updated text |
int | $submissionorgradeid | The id of the submission or grade |
bool | - true if the value was updated |
Reimplemented in assign_feedback_comments.
|
finalprotectedinherited |
Save the error message from the last error.
string | $msg | - the error description |
|
inherited |
This method is called when the mod_assign_mod_form is submitted.
It is an opportunity to validate the settings form fields added by {
array | $data | as passed to mod_assign_mod_form\validation(). |
array | $files | as passed to mod_assign_mod_form\validation(). |
array | and validation errors that should be displayed. This is array_merged with any other validation errors from the form. |
assign_submission_onlinetext::submission_is_empty | ( | stdClass | $data | ) |
Determine if a submission is empty.
This is distinct from is_empty in that it is intended to be used to determine if a submission made before saving is empty.
stdClass | $data | The submission data |
bool |
Reimplemented from assign_submission_plugin.
assign_submission_onlinetext::submission_summary_for_messages | ( | stdClass | $submission | ) |
Summarise a submission for inclusion in messages.
Moodle messages can be sent as either HTML or plain text, so you need to produce two versions of the summary.
If there is nothing in the submission from your plugin return an array of two empty strings.
The plain text version should finish in a newline character. The HTML version should have block-level elements like headings or
s as the outer elements.
stdClass | $submission | the assign_submission record for the submission the message is about. |
string[] | with two elements, a plain text summary and an HTML summary. |
Reimplemented from assign_submission_plugin.
|
inherited |
Carry out any extra processing required when the work is submitted for grading.
stdClass | $submission | the assign_submission record being submitted. |
void |
|
inherited |
Carry out any extra processing required when the work is unlocked.
stdClass | false | $submission | - assign_submission data if any |
stdClass | $flags | - User flags record |
void |
assign_submission_onlinetext::upgrade | ( | context | $oldcontext, |
stdClass | $oldassignment, | ||
stdClass | $oldsubmission, | ||
stdClass | $submission, | ||
& | $log ) |
Upgrade the submission from the old assignment to the new one.
context | $oldcontext | - the database for the old assignment context |
stdClass | $oldassignment | The data record for the old assignment |
stdClass | $oldsubmission | The data record for the old submission |
stdClass | $submission | The data record for the new submission |
string | $log | Record upgrade messages in the log |
bool | true or false - false will trigger a rollback |
Reimplemented from assign_plugin.
assign_submission_onlinetext::upgrade_settings | ( | context | $oldcontext, |
stdClass | $oldassignment, | ||
& | $log ) |
Upgrade the settings from the old assignment to the new plugin based one.
context | $oldcontext | - the database for the old assignment context |
stdClass | $oldassignment | - the database for the old assignment instance |
string | $log | record log events here |
bool | Was it a success? |
Reimplemented from assign_plugin.
assign_submission_onlinetext::view | ( | stdClass | $submission | ) |
Display the saved text content from the editor in the view table.
stdClass | $submission |
string |
Reimplemented from assign_plugin.
|
inherited |
This allows a plugin to render an introductory section which is displayed right below the activity's "intro" section on the main assignment page.
string |
|
inherited |
This allows a plugin to render a page in the context of the assignment.
If the plugin creates a link to the assignment view.php page with The following required parameters: id=coursemoduleid plugin=type pluginsubtype=assignfeedback|assignsubmission pluginaction=customaction
Then this function will be called to display the page with the pluginaction passed as action
string | $action | The plugin specified action |
string |
Reimplemented in assign_feedback_file, and assign_feedback_offline.
assign_submission_onlinetext::view_summary | ( | stdClass | $submission, |
& | $showviewlink ) |
Display onlinetext word count in the submission status table.
stdClass | $submission | |
bool | $showviewlink | - If the summary has been truncated set this to true |
string |
Reimplemented from assign_plugin.