 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Wrapper that separates quickforms syntax from moodle code. More...
Inherited by admin_uploadpicture_form, admin_uploaduser_form1, admin_uploaduser_form2, alignment_form, assign_override_form, assignfeedback_file_batch_upload_files_form, assignfeedback_file_import_zip_form, assignfeedback_file_upload_zip_form, assignfeedback_offline_import_grades_form, assignfeedback_offline_upload_grades_form, atto_managefiles_manage_form, autogroup_form, backup_files_edit_form, badges_preferences_form, base_moodleform, blog_edit_external_form, blog_edit_form, blog_preferences_form, book_chapter_edit_form, booktool_importhtml_form, cache_definition_mappings_form, cache_definition_sharing_form, cache_lock_form, cache_mode_mappings_form, cachestore_addinstance_form, cohort_edit_form, cohort_upload_form, core\form\error_feedback, core\hub\site_registration_form, core_admin\form\purge_caches, core_admin\form\testoutgoingmailconf_form, core_auth\form\verify_age_location_form, core_backup\output\copy_form, core_badges\form\badge, core_badges\form\collections, core_badges\form\external_backpack, core_badges\form\message, core_cache\output\usage_samples_form, core_calendar\local\event\forms\create, core_calendar\local\event\forms\managesubscriptions, core_calendar_export_form, core_communication\form\configure_form, core_completion_edit_base_form, core_contentbank\form\edit_content, core_course_deletecategory_form, core_course_editcategory_form, core_enrol\form\renameroles, core_form\dynamic_form, core_h5p\form\editcontent_form, core_h5p\form\uploadlibraries_form, core_role_permission_allow_form, core_role_permission_prohibit_form, core_role_preset_form, core_search\output\form\search, core_user\form\calendar_form, core_user\form\contactsitesupport_form, core_user\form\contentbank_user_preferences_form, core_user\form\defaulthomepage_form, core_webservice\token_filter, core_webservice\token_form, course_completion_form, course_edit_form, course_request_form, course_reset_form, course_restore_form, course_settings_form, coursefiles_edit_form, coursetags_form, data_existing_preset_form, data_export_form, data_import_preset_zip_form, data_save_preset_form, database_export_form, database_transfer_form, edit_calculation_form, edit_category_form, edit_criteria_form, edit_grade_form, edit_item_form, edit_letter_form, edit_outcome_form, edit_outcomeitem_form, edit_relatedbadge_form, edit_scale_form, editsection_form, endorsement_form, enrol_bulk_enrolment_change_form, enrol_guest_enrol_form, enrol_instance_edit_form, enrol_lti\local\ltiadvantage\form\create_registration_form, enrol_lti\local\ltiadvantage\form\deployment_form, enrol_lti\local\ltiadvantage\form\platform_registration_form, enrol_manual_enrol_users_form, enrol_self_empty_form, enrol_self_enrol_form, enrol_user_enrolment_form, enrol_users_addmember_form, enrol_users_assign_form, enrol_users_filter_form, essay_grading_form, event_form, external_service_authorised_user_settings_form, external_service_form, external_service_functions_form, factor_email\form\email, feedback_edit_create_template_form, feedback_edit_use_template_form, feedback_import_form, feedback_item_form, filter_local_settings_form, forumreport_summary\form\dates_filter_form, grade_export_form, grade_import_form, grade_import_form, grade_import_mapping_form, gradeimport_direct_import_form, gradeimport_direct_mapping_form, grader_report_preferences_form, gradereport_history\filter_form, grading_search_template_form, gradingform_guide_editguide, gradingform_rubric_editrubric, group_form, grouping_form, groups_import_form, import_outcomes_form, key_form, key_form, lesson_add_page_form_base, lesson_display_answer_form_essay, lesson_display_answer_form_matching, lesson_display_answer_form_multichoice_multianswer, lesson_display_answer_form_multichoice_singleanswer, lesson_display_answer_form_numerical, lesson_display_answer_form_shortanswer, lesson_display_answer_form_truefalse, lesson_import_form, lesson_override_form, lesson_page_without_answers, login_change_password_form, login_forgot_password_form, login_forgot_password_form, login_set_password_form, login_signup_form, mnet_profile_form, mnet_review_host_form, mnet_services_form, mnet_simple_host_form, mod_assign_batch_set_allocatedmarker_form, mod_assign_batch_set_marking_workflow_state_form, mod_assign_confirm_submission_form, mod_assign_extension_form, mod_assign_grade_form, mod_assign_grading_batch_operations_form, mod_assign_grading_options_form, mod_assign_quick_grading_form, mod_assign_submission_form, mod_bigbluebuttonbn\form\guest_login, mod_data_export_form, mod_data_import_form, mod_feedback_complete_form, mod_feedback_course_map_form, mod_feedback_course_select_form, mod_feedback_use_templ_form, mod_folder_edit_form, mod_forum\form\export_form, mod_forum_post_form, mod_forum_prune_form, mod_glossary_entry_form, mod_glossary_import_form, mod_lti_edit_types_form, mod_lti_register_types_form, mod_quiz\form\add_random_form, mod_quiz\form\edit_override_form, mod_quiz\form\preflight_check_form, mod_quiz\form\randomquestion_form, mod_quiz\local\reports\attempts_report_options_form, mod_scorm_report_interactions_settings, mod_scorm_report_objectives_settings, mod_scorm_report_settings, mod_wiki_comments_form, mod_wiki_create_form, mod_wiki_edit_form, mod_wiki_filesedit_form, moodleform_mod, note_edit_form, portfolio_admin_form, portfolio_export_form, portfolio_instance_select, portfolio_user_form, profiling_import_form, qbank_exportquestions\form\export_form, qbank_importquestions\form\question_import_form, qbank_managecategories\form\question_category_edit_form, qbank_managecategories\form\question_move_form, qbank_previewquestion\form\preview_options_form, qbank_tagquestion\form\tags_form, question_wizard_form, quiz_grading_settings_form, quiz_statistics_settings_form, recent_form, reject_request_form, report_eventlist_filter_form, report_outline\filter_form, repository_instance_form, repository_type_form, steps_definitions_form, switchrole_form, tag_edit_form, tiny_media\form\manage_files_form, tool_admin_presets\form\continue_form, tool_admin_presets\form\export_form, tool_admin_presets\form\import_form, tool_admin_presets\form\load_form, tool_analytics\output\form\edit_model, tool_analytics\output\form\import_model, tool_brickfield\form\registration_form, tool_capability_settings_form, tool_cohortroles\form\assign_role_cohort, tool_componentlibrary\local\examples\formelements\example, tool_customlang\form\export, tool_customlang\form\import, tool_customlang_filter_form, tool_dataprivacy\form\exportfilter_form, tool_filetypes_form, tool_generator_make_course_form, tool_generator_make_testplan_form, tool_httpsreplace\form, tool_installaddon_installfromzip_form, tool_licensemanager\form\edit_license, tool_lp\form\template_cohorts, tool_lp\form\template_plans, tool_lpimportcsv\form\export, tool_lpimportcsv\form\import, tool_lpimportcsv\form\import_confirm, tool_lpmigrate\form\migrate_framework, tool_messageinbound_edit_handler_form, tool_mfa\local\form\login_form, tool_mfa\local\form\reset_factor, tool_mfa\local\form\revoke_factor_form, tool_mfa\local\form\setup_factor_form, tool_monitor\rule_form, tool_policy\form\accept_policy, tool_policy\form\policydoc, tool_replace_form, tool_task_edit_scheduled_task_form, tool_uploadcourse_base_form, tool_usertours\local\forms\editstep, tool_usertours\local\forms\edittour, tool_usertours\local\forms\importtour, user_active_filter_form, user_add_filter_form, user_bulk_action_form, user_bulk_cohortadd_form, user_bulk_form, user_edit_editor_form, user_edit_form, user_edit_forum_form, user_edit_language_form, user_editadvanced_form, user_message_form, webservice_test_client_base_form, webservice_test_client_form, workshop_assessment_form, workshop_edit_strategy_form, workshop_evaluation_settings_form, workshop_feedbackauthor_form, workshop_feedbackreviewer_form, workshop_random_allocator_form, and workshop_submission_form.
Public Member Functions | |
| __construct ($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true, $ajaxformdata=null) | |
| The constructor function calls the abstract function definition() and it will then process and clean and attempt to validate incoming data. | |
| _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_checkbox_controller ($groupid, $text=null, $attributes=null, $originalValue=0) | |
| Adds a link/button that controls the checked state of a group of checkboxes. | |
| add_sticky_action_buttons (bool $cancel=true, ?string $submitlabel=null) | |
| Use this method to make a sticky submit/cancel button at the end of your form. | |
| definition_after_data () | |
| Dummy stub method - override if you need to setup the form depending on current values. | |
| display () | |
| Print html form. | |
| filter_shown_headers (array $shownonly) | |
| Use this method to indicate that the fieldsets should be shown as expanded and all other fieldsets should be hidden. | |
| focus ($name=NULL) | |
| To autofocus on first form element or first element with error. | |
| get_data () | |
| Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data. | |
| get_file_content ($elname) | |
| Get content of uploaded file. | |
| get_new_filename ($elname=null) | |
| Returns name of uploaded file. | |
| 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. | |
| 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 ($default_values) | |
| Load in existing data as form defaults. | |
| 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. | |
| 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. | |
| after_definition () | |
| After definition hook. | |
| definition () | |
| Form definition. | |
| 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. | |
| validate_draft_files () | |
| Internal method. | |
Protected Attributes | |
| array | $_ajaxformdata |
| submitted form data when using mforms with ajax | |
| mixed | $_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 | |
Static Protected Attributes | |
| static int | $uniqueid = 0 |
| Unique identifier to be used for action buttons. | |
Wrapper that separates quickforms syntax from moodle code.
Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly use this class you should write a class definition which extends this class or a more specific subclass such a moodleform_mod for each form you want to display and/or process with formslib.
You will write your own definition() method which performs the form set up.
1.11.0