Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
restore_moodleform Class Reference

An abstract moodleform class specially designed for the restore forms. More...

Inheritance diagram for restore_moodleform:
base_moodleform moodleform restore_review_form restore_schema_form restore_settings_form

Public Member Functions

 __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.
 

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_html_formatting (backup_setting $setting)
 Adds HTML formatting for the given backup setting, needed to group/segment correctly.
 
 after_definition ()
 After definition hook.
 
 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
 
bool $activitydiv = false
 True if we have an activity div open, false otherwise.
 
bool $coursediv = false
 True if we have a course div open, false otherwise.
 
bool $sectiondiv = false
 True if we have a section div open, false otherwise.
 
base_ui_stage $uistage = null
 The stage this form belongs to.
 

Static Protected Attributes

static int $uniqueid = 0
 Unique identifier to be used for action buttons.
 

Detailed Description

An abstract moodleform class specially designed for the restore forms.

@abstract Marked abstract here because some idiot forgot to mark it abstract in code!

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

restore_moodleform::__construct ( restore_ui_stage $uistage,
$action = null,
$customdata = null,
$method = 'post',
$target = '',
$attributes = null,
$editable = true )

Constructor.

Overridden just for the purpose of typehinting the first arg.

Parameters
restore_ui_stage$uistage
null$action
null$customdata
string$method
string$target
null$attributes
bool$editable

Member Function Documentation

◆ add_dependencies()

base_moodleform::add_dependencies ( backup_setting $setting)
inherited

Adds dependencies to the form recursively.

Parameters
backup_setting$setting

◆ add_fixed_setting()

base_moodleform::add_fixed_setting ( backup_setting $setting,
base_task $task )
inherited

Adds a fixed or static setting to the form.

Parameters
backup_setting$setting
base_task$task

◆ add_heading()

base_moodleform::add_heading ( $name,
$text )
inherited

Adds a heading to the form.

Parameters
string$name
string$text

◆ add_html_formatting()

base_moodleform::add_html_formatting ( backup_setting $setting)
protectedinherited

Adds HTML formatting for the given backup setting, needed to group/segment correctly.

Parameters
backup_setting$setting

◆ add_setting()

base_moodleform::add_setting ( backup_setting $setting,
base_task $task = null )
inherited

Adds the backup_setting as a element to the form.

Parameters
backup_setting$setting
base_task$task
Return values
bool

◆ add_settings()

base_moodleform::add_settings ( array $settingstasks)
inherited

Adds multiple backup_settings as elements to the form.

Parameters
array$settingstasksConsists of array($setting, $task) elements
Return values
bool

◆ definition()

base_moodleform::definition ( )
inherited

The standard form definition... obviously not much here.

Reimplemented from moodleform.

◆ definition_after_data()

moodle_page base_moodleform::definition_after_data ( )
inherited

Definition applied after the data is organised.

. why's it here? because I want to add elements on the fly. $PAGE

Reimplemented from moodleform.

Reimplemented in backup_confirmation_form.

◆ display()

base_moodleform::display ( )
inherited

Displays the form.

Reimplemented from moodleform.

◆ get_element()

base_moodleform::get_element ( $elementname)
inherited

Gets an element from the form if it exists.

Parameters
string$elementname
Return values
HTML_QuickForm_input|MoodleQuickForm_group

◆ is_cancelled()

base_moodleform::is_cancelled ( )
inherited

Returns true if the form was cancelled, false otherwise.

Return values
bool

Reimplemented from moodleform.

◆ remove_element()

base_moodleform::remove_element ( $elementname)
inherited

Removes an element from the form if it exists.

Parameters
string$elementname
Return values
bool

The documentation for this class was generated from the following file: