Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Public Member Functions | |
_process_submission ($method) | |
Internal method. | |
_validate_files (&$files) | |
Internal method. | |
add_action_buttons ($cancel=true, $submitlabel=null) | |
Use this method to a cancel and submit button to the end of your form. | |
add_action_buttons ($cancel=true, $submitlabel=null, $submit2label=null) | |
Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button. | |
add_checkbox_controller ($groupid, $text=null, $attributes=null, $originalValue=0) | |
Adds a link/button that controls the checked state of a group of checkboxes. | |
add_completion_rules () | |
Can be overridden to add custom completion rules if the module wishes them. | |
apply_admin_defaults ($datetimeoffsets=array()) | |
Get the list of admin settings for this module and apply any defaults/advanced/locked/required settings. | |
completion_rule_enabled ($data) | |
Called during validation. | |
data_postprocessing ($data) | |
Allows modules to modify the data returned by form get_data(). | |
data_preprocessing (&$default_values) | |
Allows module to modify data returned by get_moduleinfo_data() or prepare_new_moduleinfo_data() before calling set_data() This method is also called in the bulk activity completion form. | |
definition () | |
Form definition. | |
definition_after_data () | |
Each module which defines definition_after_data() must call this method using parent\definition_after_data();. | |
display () | |
Print html form. | |
focus ($name=NULL) | |
To autofocus on first form element or first element with error. | |
get_context () | |
Return the course context for new modules, or the module context for existing modules. | |
get_course () | |
Get the course id. | |
get_coursemodule () | |
Get the course module object. | |
get_current () | |
Get the current data for the form. | |
get_data () | |
Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data. | |
get_features () | |
Return the features this module supports. | |
get_file_content ($elname) | |
Get content of uploaded file. | |
get_instance () | |
Get the DB record for the current instance. | |
get_new_filename ($elname=null) | |
Returns name of uploaded file. | |
get_section () | |
Get the course section number (relative). | |
get_submitted_data () | |
Return submitted data without validation or NULL if there is no submitted data. | |
init_javascript_enhancement ($element, $enhancement, array $options=array(), array $strings=null) | |
Adds an initialisation call for a standard JavaScript enhancement. | |
is_cancelled () | |
Return true if a cancel button has been pressed resulting in the form being submitted. | |
is_submitted () | |
Check that form was submitted. | |
is_validated () | |
Check that form data is valid. | |
moodleform ($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) | |
Old syntax of class constructor. | |
moodleform_mod ($current, $section, $cm, $course) | |
Old syntax of class constructor. | |
no_submit_button_pressed () | |
Checks if button pressed is not for submitting the form. | |
optional_param ($name, $default, $type) | |
Checks if a parameter was passed in the previous form submission. | |
render () | |
Renders the html form (same as display, but returns the result). | |
repeat_elements ($elementobjs, $repeats, $options, $repeathiddenname, $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false, $deletebuttonname='') | |
Method to add a repeating group of elements to a form. | |
repeat_elements_fix_clone ($i, $elementclone, &$namecloned) | |
Helper used by repeat_elements(). | |
save_file ($elname, $pathname, $override=false) | |
Save file to standard filesystem. | |
save_files ($destination) | |
Save verified uploaded files into directory. | |
save_stored_file ($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/', $newfilename=null, $overwrite=false, $newuserid=null) | |
Save file to local filesystem pool. | |
save_temp_file ($elname) | |
Returns a temporary file, do not forget to delete after not needed any more. | |
set_data ($defaultvalues) | |
Sets the current values handled by services in case of update. | |
set_display_vertical () | |
Set display mode for the form when labels take full width of the form and above the elements even on big screens. | |
set_initial_dirty_state ($state=false) | |
Set the initial 'dirty' state of the form. | |
standard_grading_coursemodule_elements () | |
standard_hidden_coursemodule_elements () | |
validate_defined_fields ($validateonnosubmit=false) | |
Validate the form. | |
validation ($data, $files) | |
Dummy stub method - override if you needed to perform some extra validation. | |
Static Public Member Functions | |
static | get_js_module () |
Returns a JS module definition for the mforms JS. | |
static | mock_ajax_submit ($simulatedsubmitteddata, $simulatedsubmittedfiles=array(), $method='post', $formidentifier=null) |
Used by tests to simulate submitted form data submission via AJAX. | |
static | mock_generate_submit_keys ($data=[]) |
Used by tests to generate valid submit keys for moodle forms that are submitted with ajax data. | |
static | mock_submit ($simulatedsubmitteddata, $simulatedsubmittedfiles=array(), $method='post', $formidentifier=null) |
Used by tests to simulate submitted form data submission from the user. | |
Protected Member Functions | |
_get_post_params () | |
Internal method - should not be used anywhere. | |
add_intro_editor ($required=null, $customlabel=null) | |
Add an editor for an activity's introduction field. | |
add_rating_settings ($mform, int $itemnumber) | |
Add rating settings. | |
after_definition () | |
After definition hook. | |
apply_admin_locked_flags () | |
Get the list of admin settings for this module and apply any locked settings. | |
get_array_value_by_keys (array $array, array $keys) | |
Returns an element of multi-dimensional array given the list of keys. | |
get_draft_files ($elname) | |
Get draft files of a form element This is a protected method which will be used only inside moodleforms. | |
get_form_identifier () | |
It should returns unique identifier for the form. | |
init_features () | |
plugin_extend_coursemodule_definition_after_data () | |
Plugins can extend the coursemodule settings form after the data is set. | |
plugin_extend_coursemodule_standard_elements () | |
Plugins can extend the coursemodule settings form. | |
plugin_extend_coursemodule_validation ($data) | |
Extend the validation function from any other plugin. | |
standard_coursemodule_elements () | |
Adds all the standard elements to a form to edit the settings for an activity module. | |
standard_intro_elements ($customlabel=null) | |
Add an editor for an activity's introduction field. | |
validate_draft_files () | |
Internal method. | |
Protected Attributes | |
array | $_ajaxformdata |
submitted form data when using mforms with ajax | |
mixed | $_cm |
Course module record of the module that is being updated. | |
mixed | $_course |
Current course. | |
array | $_customcompletionelements |
Custom completion-rule elements, if enabled. | |
mixed | $_customdata |
globals workaround | |
object | $_definition_finalized = false |
definition_after_data executed flag | |
$_features | |
List of modform features. | |
MoodleQuickForm | $_form |
quickform object definition | |
string | $_formname |
name of the form | |
mixed | $_instance |
Instance of the module that is being updated. | |
string | $_modname |
name of module. | |
$_outcomesused | |
a flag indicating whether outcomes are being used | |
int | $_section |
Section of course that module instance will be put in or is in. | |
bool null | $_validated = null |
stores the validation result of this form or null if not yet validated | |
bool | $applyadminlockedflags = false |
A flag used to indicate that this module should lock settings based on admin settings flags in definition_after_data. | |
$context | |
current context, course or module depends if already exists | |
object | $courseformat |
The course format of the current course. | |
$current | |
Current data. | |
|
inherited |
Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button.
bool | $cancel | show cancel button |
string | $submitlabel | null means default, false means none, string is label text |
string | $submit2label | null means default, false means none, string is label text |
void |
|
inherited |
Can be overridden to add custom completion rules if the module wishes them.
If overriding this, you should also override completion_rule_enabled.
Just add elements to the form as needed and return the list of IDs. The system will call disabledIf and handle other behaviour for each returned ID.
array | Array of string IDs of added items, empty array if none |
Reimplemented in mod_assign_mod_form, mod_bigbluebuttonbn_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_scorm_mod_form, and mod_survey_mod_form.
|
protectedinherited |
Add an editor for an activity's introduction field.
null | $required | Override system default for requiremodintro |
null | $customlabel | Override default label for editor |
coding_exception |
|
protectedinherited |
Add rating settings.
moodleform_mod | $mform | |
int | $itemnumber |
|
inherited |
Get the list of admin settings for this module and apply any defaults/advanced/locked/required settings.
$datetimeoffsets | array - If passed, this is an array of fieldnames => times that the default date/time value should be relative to. If not passed, all date/time fields are set relative to the users current midnight. |
void |
|
protectedinherited |
Get the list of admin settings for this module and apply any locked settings.
This cannot happen in apply_admin_defaults because we do not the current values of the settings in that function because set_data has not been called yet.
void |
|
inherited |
Called during validation.
Override to indicate, based on the data, whether a custom completion rule is enabled (selected).
array | $data | Input data (not yet validated) |
bool | True if one or more rules is enabled, false if none are; default returns false |
Reimplemented in mod_assign_mod_form, mod_bigbluebuttonbn_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_scorm_mod_form, and mod_survey_mod_form.
|
inherited |
Allows modules to modify the data returned by form get_data().
This method is also called in the bulk activity completion form.
Only available on moodleform_mod.
stdClass | $data | passed by reference |
Reimplemented in mod_bigbluebuttonbn_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_h5pactivity_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_scorm_mod_form, mod_survey_mod_form, and mod_workshop_mod_form.
|
inherited |
Allows module to modify data returned by get_moduleinfo_data() or prepare_new_moduleinfo_data() before calling set_data() This method is also called in the bulk activity completion form.
Only available on moodleform_mod.
array | $default_values | passed by reference |
Reimplemented in mod_assign_mod_form, mod_bigbluebuttonbn_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_folder_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_h5pactivity_mod_form, mod_lesson_mod_form, mod_page_mod_form, mod_quiz_mod_form, mod_resource_mod_form, mod_scorm_mod_form, mod_url_mod_form, and mod_workshop_mod_form.
mod_lti_mod_form::definition | ( | ) |
|
inherited |
Each module which defines definition_after_data() must call this method using parent\definition_after_data();.
Reimplemented from moodleform.
Reimplemented in mod_forum_mod_form, mod_glossary_mod_form, mod_resource_mod_form, and mod_workshop_mod_form.
|
inherited |
Return the course context for new modules, or the module context for existing modules.
context |
|
inherited |
Get the course id.
int |
|
inherited |
Get the course module object.
stdClass|null |
|
inherited |
Get the current data for the form.
stdClass|null |
|
inherited |
Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data.
Do not override this method, override data_postprocessing() instead.
object | submitted data; NULL if not valid or not submitted or cancelled |
Reimplemented from moodleform.
Reimplemented in mod_forum_mod_form.
|
inherited |
Return the features this module supports.
stdClass |
|
inherited |
Get the DB record for the current instance.
stdClass|null |
|
inherited |
Get the course section number (relative).
int |
|
inherited |
|
protectedinherited |
Extend the validation function from any other plugin.
stdClass | $data | The form data. |
array\$errors | The list of errors keyed by element name. |
mod_lti_mod_form::set_data | ( | $defaultvalues | ) |
Sets the current values handled by services in case of update.
object | $defaultvalues | default values to populate the form with. |
Reimplemented from moodleform_mod.
|
protectedinherited |
Add an editor for an activity's introduction field.
null | $customlabel | Override default label for editor |
coding_exception |
|
inherited |
Dummy stub method - override if you needed to perform some extra validation.
If there are errors return array of errors ("fieldname"=>"error message"), otherwise true if ok.
Server side rules do not work for uploaded files, implement serverside rules here if needed.
array | $data | array of ("fieldname"=>value) of submitted data |
array | $files | array of uploaded files "element_name"=>tmp_file_path |
array | of "element_name"=>"error_description" if there are errors, or an empty array if everything is OK (true allowed for backwards compatibility too). |
Reimplemented from moodleform.
Reimplemented in mod_assign_mod_form, mod_bigbluebuttonbn_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_folder_mod_form, mod_forum_mod_form, mod_h5pactivity_mod_form, mod_imscp_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_resource_mod_form, mod_scorm_mod_form, mod_url_mod_form, and mod_workshop_mod_form.
|
protectedinherited |
Course module record of the module that is being updated.
Will be null if this is an 'add' form and not an update one.
|
protectedinherited |
Instance of the module that is being updated.
This is the id of the {prefix}{modulename} record. Can be used in form definition. Will be "" if this is an 'add' form and not an update one.
|
protectedinherited |
Section of course that module instance will be put in or is in.
This is always the section number itself (column 'section' from 'course_sections' table).