 |
Moodle APIs
3.8
Moodle 3.8.6 (Build: 20201109)
|
|
Moodle APIs
3.8
Moodle 3.8.6 (Build: 20201109)
|
Public Member Functions | |
| _process_submission ($method) | |
| Internal method. More... | |
| _validate_files (&$files) | |
| Internal method. More... | |
| add_action_buttons ($cancel=true, $submitlabel=null) | |
| Use this method to a cancel and submit button to the end of your form. More... | |
| add_checkbox_controller ($groupid, $text=null, $attributes=null, $originalValue=0) | |
| Adds a link/button that controls the checked state of a group of checkboxes. More... | |
| definition () | |
| The form definition. | |
| definition_after_data () | |
| Dummy stub method - override if you need to setup the form depending on current values. More... | |
| display () | |
| Print html form. | |
| focus ($name=NULL) | |
| To autofocus on first form element or first element with error. More... | |
| get_data () | |
| Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data. More... | |
| get_file_content ($elname) | |
| Get content of uploaded file. More... | |
| get_new_filename ($elname=null) | |
| Returns name of uploaded file. More... | |
| get_params () | |
| Get the parameters that the user submitted using the form. More... | |
| get_submitted_data () | |
| Return submitted data without validation or NULL if there is no submitted data. More... | |
| init_javascript_enhancement ($element, $enhancement, array $options=array(), array $strings=null) | |
| Adds an initialisation call for a standard JavaScript enhancement. More... | |
| is_cancelled () | |
| Return true if a cancel button has been pressed resulting in the form being submitted. More... | |
| is_submitted () | |
| Check that form was submitted. More... | |
| is_validated () | |
| Check that form data is valid. More... | |
| moodleform ($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) | |
| Old syntax of class constructor. More... | |
| no_submit_button_pressed () | |
| Checks if button pressed is not for submitting the form. More... | |
| optional_param ($name, $default, $type) | |
| Checks if a parameter was passed in the previous form submission. More... | |
| render () | |
| Renders the html form (same as display, but returns the result). More... | |
| repeat_elements ($elementobjs, $repeats, $options, $repeathiddenname, $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false) | |
| Method to add a repeating group of elements to a form. More... | |
| repeat_elements_fix_clone ($i, $elementclone, &$namecloned) | |
| Helper used by repeat_elements(). More... | |
| save_file ($elname, $pathname, $override=false) | |
| Save file to standard filesystem. More... | |
| save_files ($destination) | |
| Save verified uploaded files into directory. More... | |
| save_stored_file ($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/', $newfilename=null, $overwrite=false, $newuserid=null) | |
| Save file to local filesystem pool. More... | |
| save_temp_file ($elname) | |
| Returns a temporary file, do not forget to delete after not needed any more. More... | |
| set_data ($default_values) | |
| Load in existing data as form defaults. More... | |
| 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. More... | |
| set_initial_dirty_state ($state=false) | |
| Set the initial 'dirty' state of the form. More... | |
| validate_defined_fields ($validateonnosubmit=false) | |
| Validate the form. More... | |
| validation ($data, $files) | |
| Dummy stub method - override if you needed to perform some extra validation. More... | |
Static Public Member Functions | |
| static | get_js_module () |
| Returns a JS module definition for the mforms JS. More... | |
| static | mock_generate_submit_keys ($data=[]) |
| Used by tests to generate valid submit keys for moodle forms that are submitted with ajax data. More... | |
| static | mock_submit ($simulatedsubmitteddata, $simulatedsubmittedfiles=array(), $method='post', $formidentifier=null) |
| Used by tests to simulate submitted form data submission from the user. More... | |
Protected Member Functions | |
| _get_post_params () | |
| Internal method - should not be used anywhere. More... | |
| after_definition () | |
| After definition hook. More... | |
| get_draft_files ($elname) | |
| Get draft files of a form element This is a protected method which will be used only inside moodleforms. More... | |
| get_form_identifier () | |
| It should returns unique identifier for the form. More... | |
| test_client_definition () | |
| Definition of the parameters used by this WS function. | |
| validate_draft_files () | |
| Internal method. More... | |
Protected Attributes | |
| array | $_ajaxformdata |
| submitted form data when using mforms with ajax | |
| array | $_customdata |
| globals workaround | |
| object | $_definition_finalized = false |
| definition_after_data executed flag | |
| MoodleQuickForm | $_form |
| quickform object definition | |
| string | $_formname |
| name of the form | |
| bool null | $_validated = null |
| stores the validation result of this form or null if not yet validated | |
|
protectedinherited |
|
inherited |
Internal method.
Alters submitted data to be suitable for quickforms processing. Must be called when the form is fully set up.
| string | $method | name of the method which alters submitted data |
|
inherited |
Internal method.
Validates all old-style deprecated uploaded files. The new way is to upload files via repository api.
| array | $files | list of files to be validated |
| bool|array | Success or an array of errors |
|
inherited |
Use this method to a cancel and submit button to the end of your form.
Pass a param of false if you don't want a cancel button in your form. If you have a cancel button make sure you check for it being pressed using is_cancelled() and redirecting if it is true before trying to get data with get_data().
| bool | $cancel | whether to show cancel button, default true |
| string | $submitlabel | label for submit button, defaults to get_string('savechanges') |
Reimplemented in tool_uploadcourse_step2_form.
|
inherited |
Adds a link/button that controls the checked state of a group of checkboxes.
| int | $groupid | The id of the group of advcheckboxes this element controls |
| string | $text | The text of the link. Defaults to selectallornone ("select all/none") |
| array | $attributes | associative array of HTML attributes |
| int | $originalValue | The original general state of the checkboxes before the user first clicks this element |
|
protectedinherited |
After definition hook.
This is useful for intermediate classes to inject logic after the definition was provided without requiring developers to call the parent self::definition() as it's not obvious by design. The 'intermediate' class is 'MyClass extends IntermediateClass extends moodleform'.
Classes overriding this method should always call the parent. We may not add anything specifically in this instance of the method, but intermediate classes are likely to do so, and so it is a good practice to always call the parent.
| void |
Reimplemented in core\form\persistent.
|
inherited |
Dummy stub method - override if you need to setup the form depending on current values.
This method is called after definition(), data submission and set_data(). All form setup that is dependent on form values should go in here.
Reimplemented in field_form, user_edit_language_form, user_editadvanced_form, user_edit_form, core_user\form\calendar_form, report_outline\filter_form, mod_workshop_mod_form, mod_resource_mod_form, mod_glossary_mod_form, mod_forum_mod_form, book_chapter_edit_form, login_signup_form, group_form, gradereport_history\filter_form, gradingform_rubric_editrubric, gradingform_guide_editguide, edit_outcomeitem_form, edit_item_form, edit_grade_form, edit_category_form, edit_calculation_form, edit_scale_form, edit_outcome_form, moodleform_mod, editsection_form, course_edit_form, cohort_upload_form, core_calendar\local\event\forms\managesubscriptions, blog_edit_external_form, base_moodleform, backup_confirmation_form, external_service_form, admin_uploaduser_form2, and tool_uploadcourse_step2_form.
|
inherited |
To autofocus on first form element or first element with error.
| string | $name | if this is set then the focus is forced to a field with this name |
| string | javascript to select form element with first error or first element if no errors. Use this as a parameter when calling print_header |
|
inherited |
Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data.
note: $slashed param removed
| object | submitted data; NULL if not valid or not submitted or cancelled |
Reimplemented in mod_lti_edit_types_form, lesson_add_page_form_numerical, mod_forum_mod_form, feedback_textfield_form, feedback_textarea_form, feedback_numeric_form, feedback_multichoicerated_form, feedback_multichoice_form, feedback_item_form, core\hub\site_registration_form, core\form\persistent, gradingform_rubric_editrubric, gradingform_guide_editguide, grade_export_form, moodleform_mod, editsection_form, core_completion_edit_base_form, block_edit_form, web_service_token_form, admin_uploaduser_form2, tool_policy\form\policydoc, and tool_filetypes_form.
|
protectedinherited |
Get draft files of a form element This is a protected method which will be used only inside moodleforms.
| string | $elname | name of element |
| array|bool|null |
|
inherited |
Get content of uploaded file.
| string | $elname | name of file upload element |
| string|bool | false in case of failure, string if ok |
|
protectedinherited |
It should returns unique identifier for the form.
Currently it will return class name, but in case two same forms have to be rendered on same page then override function to get unique form identifier. e.g This is used on multiple self enrollments page.
| string | form identifier. |
Reimplemented in mod_assign_grade_form, and enrol_self_enrol_form.
|
staticinherited |
Returns a JS module definition for the mforms JS.
| array |
|
inherited |
Returns name of uploaded file.
| string | $elname | first element if null |
| string|bool | false in case of failure, string if ok |
| webservice_test_client_base_form::get_params | ( | ) |
Get the parameters that the user submitted using the form.
| array|null |
Reimplemented in core_get_string_testclient_form, core_course_update_categories_testclient_form, core_course_delete_categories_testclient_form, and core_course_create_categories_testclient_form.
|
inherited |
Return submitted data without validation or NULL if there is no submitted data.
note: $slashed param removed
| object | submitted data; NULL if not submitted |
Reimplemented in lesson_add_page_form_numerical, and core\form\persistent.
|
inherited |
Adds an initialisation call for a standard JavaScript enhancement.
This function is designed to add an initialisation call for a JavaScript enhancement that should exist within javascript-static M.form.init_{enhancementname}.
Current options:
| string | element | $element | form element for which Javascript needs to be initalized |
| string | $enhancement | which init function should be called |
| array | $options | options passed to javascript |
| array | $strings | strings for javascript |
|
inherited |
Return true if a cancel button has been pressed resulting in the form being submitted.
| bool | true if a cancel button has been pressed |
Reimplemented in base_moodleform.
|
inherited |
Check that form was submitted.
Does not check validity of submitted data.
| bool | true if form properly submitted |
|
inherited |
Check that form data is valid.
You should almost always use this, rather than validate_defined_fields
| bool | true if form data valid |
|
staticinherited |
Used by tests to generate valid submit keys for moodle forms that are submitted with ajax data.
| moodle_exception | If called outside unit test environment |
| array | $data | Existing form data you wish to add the keys to. |
| array |
|
staticinherited |
Used by tests to simulate submitted form data submission from the user.
For form fields where no data is submitted the default for that field as set by set_data or setDefault will be passed to get_data.
This method sets $_POST or $_GET and $_FILES with the data supplied. Our unit test code empties all these global arrays after each test.
| array | $simulatedsubmitteddata | An associative array of form values (same format as $_POST). |
| array | $simulatedsubmittedfiles | An associative array of files uploaded (same format as $_FILES). Can be omitted. |
| string | $method | 'post' or 'get', defaults to 'post'. |
| null | $formidentifier | the default is to use the class name for this class but you may need to provide a different value here for some forms that are used more than once on the same page. |
|
inherited |
|
inherited |
Checks if button pressed is not for submitting the form.
@staticvar bool $nosubmit keeps track of no submit button
| bool |
|
inherited |
Checks if a parameter was passed in the previous form submission.
| string | $name | the name of the page parameter we want |
| mixed | $default | the default value to return if nothing is found |
| string | $type | expected type of parameter |
| mixed |
|
inherited |
Renders the html form (same as display, but returns the result).
Note that you can only output this rendered result once per page, as it contains IDs which must be unique.
| string | HTML code for the form |
|
inherited |
Method to add a repeating group of elements to a form.
| array | $elementobjs | Array of elements or groups of elements that are to be repeated |
| int | $repeats | no of times to repeat elements initially |
| array | $options | a nested array. The first array key is the element name. the second array key is the type of option to set, and depend on that option, the value takes different forms. 'default' - default value to set. Can include '{no}' which is replaced by the repeat number. 'type' - PARAM_* type. 'helpbutton' - array containing the helpbutton params. 'disabledif' - array containing the disabledIf() arguments after the element name. 'rule' - array containing the addRule arguments after the element name. 'expanded' - whether this section of the form should be expanded by default. (Name be a header element.) 'advanced' - whether this element is hidden by 'Show more ...'. |
| string | $repeathiddenname | name for hidden element storing no of repeats in this form |
| string | $addfieldsname | name for button to add more fields |
| int | $addfieldsno | how many fields to add at a time |
| string | $addstring | name of button, {no} is replaced by no of blanks that will be added. |
| bool | $addbuttoninside | if true, don't call closeHeaderBefore($addfieldsname). Default false. |
| int | no of repeats of element in this page |
|
inherited |
Helper used by repeat_elements().
| int | $i | the index of this element. |
| HTML_QuickForm_element | $elementclone | |
| array | $namecloned | array of names |
|
inherited |
Save file to standard filesystem.
| string | $elname | name of element |
| string | $pathname | full path name of file |
| bool | $override | override file if exists |
| bool | success |
|
inherited |
Save verified uploaded files into directory.
Upload process can be customised from definition()
| string | $destination | path where file should be stored |
| bool | Always false |
|
inherited |
Save file to local filesystem pool.
| string | $elname | name of element |
| int | $newcontextid | id of context |
| string | $newcomponent | name of the component |
| string | $newfilearea | name of file area |
| int | $newitemid | item id |
| string | $newfilepath | path of file where it get stored |
| string | $newfilename | use specified filename, if not specified name of uploaded file used |
| bool | $overwrite | overwrite file if exists |
| int | $newuserid | new userid if required |
| mixed | stored_file object or false if error; may throw exception if duplicate found |
|
inherited |
Returns a temporary file, do not forget to delete after not needed any more.
| string | $elname | name of the elmenet |
| string|bool | either string or false |
|
inherited |
Load in existing data as form defaults.
Usually new entry defaults are stored directly in form definition (new entry form); this function is used to load in data where values already exist and data is being edited (edit entry form).
note: $slashed param removed
| stdClass | array | $default_values | object or array of default values |
Reimplemented in qtype_random_edit_form, qtype_multianswer_edit_form, qtype_missingtype_edit_form, question_edit_form, question_dataset_dependent_items_form, feedback_multichoicerated_form, feedback_multichoice_form, mod_scorm_mod_form, mod_quiz\form\randomquestion_form, lesson_add_page_form_numerical, block_html_edit_form, block_edit_form, moodleform_mod, editsection_form, cache_definition_sharing_form, tool_filetypes_form, tool_dataprivacy\form\purpose, question_category_edit_form, and core_badges\form\badge.
|
inherited |
Set display mode for the form when labels take full width of the form and above the elements even on big screens.
Useful for forms displayed inside modals or in narrow containers
|
inherited |
Set the initial 'dirty' state of the form.
| bool | $state |
|
inherited |
Validate the form.
You almost always want to call } instead of this * because it calls definition_after_data first, before validating the form, which is what you want in 99% of cases.
This is provided as a separate function for those special cases where you want the form validated before definition_after_data is called for example, to selectively add new elements depending on a no_submit_button press, but only when the form is valid when the no_submit_button is pressed,
| bool | $validateonnosubmit | optional, defaults to false. The default behaviour is NOT to validate the form when a no submit button has been pressed. pass true here to override this behaviour |
| bool | true if form data valid |
|
protectedinherited |
Internal method.
Validates filepicker and filemanager files if they are set as required fields. Also, sets the error message if encountered one.
| bool|array | with errors |
|
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 in user_editadvanced_form, user_edit_form, qtype_random_edit_form, qtype_essay_edit_form, question_edit_form, quiz_add_random_form, core_customfield\field_config_form, field_form, category_form, user_files_form, tag_edit_form, repository_type_form, repository_instance_form, qtype_shortanswer_edit_form, qtype_randomsamatch_edit_form, qtype_numerical_edit_form, qtype_multichoice_edit_form, qtype_multianswer_edit_form, qtype_missingtype_edit_form, qtype_match_edit_form, qtype_gapselect_edit_form_base, qtype_ddmarker_edit_form, qtype_ddimageortext_edit_form, qtype_calculatedsimple_edit_form, qtype_calculatedmulti_edit_form, qtype_calculated_edit_form, question_dataset_dependent_items_form, question_dataset_dependent_definitions_form, question_import_form, question_category_edit_form, workshop_submission_form, mod_workshop_mod_form, workshop_rubric_assessment_form, workshop_edit_strategy_form, workshop_feedbackreviewer_form, workshop_feedbackauthor_form, mod_url_mod_form, mod_scorm_mod_form, mod_resource_mod_form, quiz_responses_settings_form, mod_quiz_attempts_report_form, quiz_override_form, mod_quiz_mod_form, mod_quiz_preflight_check_form, mod_lti_edit_types_form, lesson_override_form, mod_lesson_mod_form, lesson_import_form, mod_imscp_mod_form, mod_glossary_entry_form, mod_forum_mod_form, mod_forum_post_form, mod_folder_mod_form, mod_feedback_mod_form, feedback_edit_create_template_form, mod_data_mod_form, mod_choice_mod_form, booktool_importhtml_form, assign_override_form, mod_assign_mod_form, mod_assign_grade_form, mod_assign_extension_form, mod_assign_batch_set_marking_workflow_state_form, login_signup_form, login_set_password_form, login_forgot_password_form, login_change_password_form, portfolio_user_form, portfolio_admin_form, portfolio_export_form, core\hub\site_registration_form, core\form\persistent, grouping_form, group_form, autogroup_form, grader_report_preferences_form, grade_import_form, gradingform_rubric_editrubric, gradingform_guide_editguide, edit_outcomeitem_form, edit_item_form, edit_category_form, edit_calculation_form, edit_scale_form, edit_outcome_form, enrol_self_enrol_form, enrol_manual_enrol_users_form, enrol_guest_enrol_form, enrol_instance_edit_form, enrol_user_enrolment_form, course_reset_form, course_request_form, moodleform_mod, editsection_form, course_edit_form, core_course_editcategory_form, core_course_deletecategory_form, core_completion_edit_base_form, core_completion_bulkedit_form, cohort_upload_form, cohort_edit_form, event_form, core_calendar\local\event\forms\managesubscriptions, core_calendar\local\event\forms\create, cachestore_memcached_addinstance_form, cache_lock_form, cache_definition_sharing_form, cachestore_addinstance_form, blog_edit_external_form, blog_edit_form, edit_relatedbadge_form, endorsement_form, edit_criteria_form, core_badges\form\badge, core_badges\form\backpack, alignment_form, backup_confirmation_form, web_service_token_form, external_service_form, admin_uploaduser_form2, tool_uploadcourse_step2_form, tool_task_edit_scheduled_task_form, tool_replace_form, tool_policy\form\policydoc, tool_monitor\rule_form, tool_lpmigrate\form\migrate_framework, tool_installaddon_installfromzip_form, tool_generator_make_testplan_form, tool_generator_make_course_form, tool_filetypes_form, database_transfer_form, tool_analytics\output\form\edit_model, core_role_preset_form, mnet_review_host_form, mnet_simple_host_form, and core_admin\form\purge_caches.
1.8.20