|
| _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.
|
|
| add_completiongrade_rules () |
| Add completion grading elements to the form and return the list of element ids.
|
|
| 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.
|
|
| 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 module 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.
|
|
| 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_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 ($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.
|
|
| standard_grading_coursemodule_elements () |
|
| standard_hidden_coursemodule_elements () |
|
| validate_defined_fields ($validateonnosubmit=false) |
| Validate the form.
|
|
| validation ($data, $files) |
| Enforce validation rules here.
|
|
|
| _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.
|
|
|
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.
|
|