|
| __construct (restore_ui_stage $uistage, $action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) |
| Constructor.
|
|
| _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_dependencies (backup_setting $setting) |
| Adds dependencies to the form recursively.
|
|
| add_fixed_setting (backup_setting $setting, base_task $task) |
| Adds a fixed or static setting to the form.
|
|
| add_heading ($name, $text) |
| Adds a heading to the form.
|
|
| add_setting (backup_setting $setting, base_task $task=null) |
| Adds the backup_setting as a element to the form.
|
|
| add_settings (array $settingstasks) |
| Adds multiple backup_settings as elements to the form.
|
|
| 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.
|
|
| close_task_divs () |
| Closes any open divs.
|
|
| definition () |
| The standard form definition... obviously not much here.
|
|
moodle_page | definition_after_data () |
| Definition applied after the data is organised.
|
|
| display () |
| Displays the 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_element ($elementname) |
| Gets an element from the form if it exists.
|
|
| 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 () |
| Returns true if the form was cancelled, false otherwise.
|
|
| 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.
|
|
| remove_element ($elementname) |
| Removes an element from the form if it exists.
|
|
| 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().
|
|
| require_definition_after_data () |
| Ensures the the definition after data is loaded.
|
|
| 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.
|
|
An abstract moodleform class specially designed for the restore forms.
@abstract Marked abstract here because some idiot forgot to mark it abstract in code!
- Copyright
- 2010 Sam Hemelryk
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later