Inheritance diagram for mod_lti_mod_form:

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

	add_completion_rules ()
	Can be overridden to add custom completion rules if the module wishes them. More...

	apply_admin_defaults ($datetimeoffsets=array())
	Get the list of admin settings for this module and apply any defaults/advanced/locked/required settings. More...

	completion_rule_enabled ($data)
	Called during validation. More...

	data_postprocessing ($data)
	Allows modules to modify the data returned by form get_data(). More...

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

	definition ()
	Form definition. More...

	definition_after_data ()
	Each module which defines definition_after_data() must call this method using parent::definition_after_data();. More...

	display ()
	Print html form. More...

	focus ($name=NULL)
	To autofocus on first form element or first element with error. More...

	get_context ()
	Return the course context for new modules, or the module context for existing modules. More...

	get_course ()
	Get the course id. More...

	get_coursemodule ()
	Get the course module object. More...

	get_current ()
	Get the current data for the form. More...

	get_data ()
	Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data. More...

	get_features ()
	Return the features this module supports. More...

	get_file_content ($elname)
	Get content of uploaded file. More...

	get_instance ()
	Get the DB record for the current instance. More...

	get_new_filename ($elname=null)
	Returns name of uploaded file. More...

	get_section ()
	Get the course section number (relative). 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...

	moodleform_mod ($current, $section, $cm, $course)
	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 ($defaultvalues)
	Sets the current values handled by services in case of update. 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...

	standard_grading_coursemodule_elements ()

	standard_hidden_coursemodule_elements ()

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

	add_intro_editor ($required=null, $customlabel=null)
	Add an editor for an activity's introduction field. More...

	add_rating_settings ($mform, int $itemnumber)
	Add rating settings. More...

	after_definition ()
	After definition hook. More...

	apply_admin_locked_flags ()
	Get the list of admin settings for this module and apply any locked settings. 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...

	init_features ()

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

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

	validate_draft_files ()
	Internal method. More...

Protected Attributes
array	$_ajaxformdata
	submitted form data when using mforms with ajax

mixed	$_cm
	Course module record of the module that is being updated. More...

mixed	$_course
	Current course.

array	$_customcompletionelements
	Custom completion-rule elements, if enabled.

array	$_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. More...

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

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.

Member Function Documentation

◆ _get_post_params()

moodleform::_get_post_params ( )

protectedinherited

Internal method - should not be used anywhere.

Deprecated:: since 2.6

Return values

array::$_POST,.

◆ _process_submission()

moodleform::_process_submission ( $method )

inherited

Internal method.

Alters submitted data to be suitable for quickforms processing. Must be called when the form is fully set up.

Parameters

string $method name of the method which alters submitted data

◆ _validate_files()

moodleform::_validate_files ( & $files )

inherited

Internal method.

Validates all old-style deprecated uploaded files. The new way is to upload files via repository api.

Parameters

array $files list of files to be validated

Return values

bool|array Success or an array of errors

◆ add_action_buttons() [1/2]

moodleform::add_action_buttons	(	$cancel = `true`,
		$submitlabel = `null`
	)

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().

Parameters

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, and core_contentbank\form\edit_content.

◆ add_action_buttons() [2/2]

moodleform_mod::add_action_buttons	(	$cancel = `true`,
		$submitlabel = `null`,
		$submit2label = `null`
	)

inherited

Overriding formslib's add_action_buttons() method, to add an extra submit "save changes and return" button.

Parameters

bool	$cancel	show cancel button
string	$submitlabel	null means default, false means none, string is label text
string	$submit2label	null means default, false means none, string is label text

Return values

void

◆ add_checkbox_controller()

moodleform::add_checkbox_controller	(	$groupid,
		$text = `null`,
		$attributes = `null`,
		$originalValue = `0`
	)

inherited

Adds a link/button that controls the checked state of a group of checkboxes.

Parameters

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

◆ add_completion_rules()

moodleform_mod::add_completion_rules ( )

inherited

Can be overridden to add custom completion rules if the module wishes them.

If overriding this, you should also override completion_rule_enabled.

Just add elements to the form as needed and return the list of IDs. The system will call disabledIf and handle other behaviour for each returned ID.

Return values

array Array of string IDs of added items, empty array if none

Reimplemented in mod_assign_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_scorm_mod_form, and mod_survey_mod_form.

◆ add_intro_editor()

moodleform_mod::add_intro_editor	(	$required = `null`,
		$customlabel = `null`
	)

protectedinherited

Add an editor for an activity's introduction field.

Deprecated:: since MDL-49101 - use moodleform_mod::standard_intro_elements() instead.

Parameters

null	$required	Override system default for requiremodintro
null	$customlabel	Override default label for editor

Exceptions

coding_exception

◆ add_rating_settings()

moodleform_mod::add_rating_settings	(		$mform,
		int	$itemnumber
	)

protectedinherited

Add rating settings.

Parameters

moodleform_mod	$mform
int	$itemnumber

◆ after_definition()

moodleform::after_definition ( )

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.

Return values

void

Reimplemented in core\form\persistent.

◆ apply_admin_defaults()

moodleform_mod::apply_admin_defaults ( $datetimeoffsets = array() )

inherited

Get the list of admin settings for this module and apply any defaults/advanced/locked/required settings.

Parameters

$datetimeoffsets array - If passed, this is an array of fieldnames => times that the default date/time value should be relative to. If not passed, all date/time fields are set relative to the users current midnight.

Return values

void

◆ apply_admin_locked_flags()

moodleform_mod::apply_admin_locked_flags ( )

protectedinherited

Get the list of admin settings for this module and apply any locked settings.

This cannot happen in apply_admin_defaults because we do not the current values of the settings in that function because set_data has not been called yet.

Return values

void

◆ completion_rule_enabled()

moodleform_mod::completion_rule_enabled ( $data )

inherited

Called during validation.

Override to indicate, based on the data, whether a custom completion rule is enabled (selected).

Parameters

array $data Input data (not yet validated)

Return values

bool	True if one or more rules is enabled, false if none are; default returns false

Reimplemented in mod_assign_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_scorm_mod_form, and mod_survey_mod_form.

◆ data_postprocessing()

moodleform_mod::data_postprocessing ( $data )

inherited

Allows modules to modify the data returned by form get_data().

This method is also called in the bulk activity completion form.

Only available on moodleform_mod.

Parameters

stdClass $data passed by reference

Reimplemented in mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_h5pactivity_mod_form, mod_lesson_mod_form, mod_scorm_mod_form, mod_survey_mod_form, and mod_workshop_mod_form.

◆ data_preprocessing()

moodleform_mod::data_preprocessing ( & $default_values )

inherited

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.

Only available on moodleform_mod.

Parameters

array $default_values passed by reference

Reimplemented in mod_workshop_mod_form, mod_choice_mod_form, mod_feedback_mod_form, mod_folder_mod_form, mod_forum_mod_form, mod_glossary_mod_form, mod_resource_mod_form, mod_url_mod_form, mod_assign_mod_form, mod_data_mod_form, mod_h5pactivity_mod_form, mod_lesson_mod_form, mod_page_mod_form, mod_scorm_mod_form, and mod_quiz_mod_form.

◆ definition()

mod_lti_mod_form::definition ( )

Form definition.

Abstract method - always override!

Reimplemented from moodleform.

◆ definition_after_data()

moodleform_mod::definition_after_data ( )

inherited

Each module which defines definition_after_data() must call this method using parent::definition_after_data();.

Reimplemented from moodleform.

Reimplemented in mod_forum_mod_form, mod_glossary_mod_form, mod_resource_mod_form, and mod_workshop_mod_form.

◆ display()

moodleform::display ( )

inherited

Print html form.

Reimplemented in base_moodleform, cohort_upload_form, and mod_feedback_complete_form.

◆ focus()

moodleform::focus ( $name = NULL )

inherited

To autofocus on first form element or first element with error.

Parameters

string $name if this is set then the focus is forced to a field with this name

Return values

string javascript to select form element with first error or first element if no errors. Use this as a parameter when calling print_header

◆ get_context()

moodleform_mod::get_context ( )

inherited

Return the course context for new modules, or the module context for existing modules.

Return values

context

◆ get_course()

moodleform_mod::get_course ( )

inherited

Get the course id.

Return values

int

◆ get_coursemodule()

moodleform_mod::get_coursemodule ( )

inherited

Get the course module object.

Return values

stdClass|null

◆ get_current()

moodleform_mod::get_current ( )

inherited

Get the current data for the form.

Return values

stdClass|null

◆ get_data()

moodleform_mod::get_data ( )

inherited

Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data.

Do not override this method, override data_postprocessing() instead.

Return values

object submitted data; NULL if not valid or not submitted or cancelled

Reimplemented from moodleform.

Reimplemented in mod_forum_mod_form.

◆ get_draft_files()

moodleform::get_draft_files ( $elname )

protectedinherited

Get draft files of a form element This is a protected method which will be used only inside moodleforms.

Parameters

string $elname name of element

Return values

array|bool|null

◆ get_features()

moodleform_mod::get_features ( )

inherited

Return the features this module supports.

Return values

stdClass

◆ get_file_content()

moodleform::get_file_content ( $elname )

inherited

Get content of uploaded file.

Parameters

string $elname name of file upload element

Return values

string|bool false in case of failure, string if ok

◆ get_form_identifier()

moodleform::get_form_identifier ( )

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.

Return values

string form identifier.

Reimplemented in enrol_self_enrol_form, and mod_assign_grade_form.

◆ get_instance()

moodleform_mod::get_instance ( )

inherited

Get the DB record for the current instance.

Return values

stdClass|null

◆ get_js_module()

static moodleform::get_js_module ( )

staticinherited

Returns a JS module definition for the mforms JS.

Return values

array

◆ get_new_filename()

moodleform::get_new_filename ( $elname = null )

inherited

Returns name of uploaded file.

Parameters

string $elname first element if null

Return values

string|bool false in case of failure, string if ok

◆ get_section()

moodleform_mod::get_section ( )

inherited

Get the course section number (relative).

Return values

int

◆ get_submitted_data()

moodleform::get_submitted_data ( )

inherited

Return submitted data without validation or NULL if there is no submitted data.

note: $slashed param removed

Return values

object submitted data; NULL if not submitted

Reimplemented in core\form\persistent, and lesson_add_page_form_numerical.

◆ init_javascript_enhancement()

moodleform::init_javascript_enhancement	(		$element,
			$enhancement,
		array	$options = `array()`,
		array	$strings = `null`
	)

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:

Selectboxes
- smartselect: Turns a nbsp indented select box into a custom drop down control that supports multilevel and category selection. $enhancement = 'smartselect'; $options = array('selectablecategories' => true|false)

Parameters

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

Deprecated:: since Moodle 3.3 MDL-57471

◆ is_cancelled()

moodleform::is_cancelled ( )

inherited

Return true if a cancel button has been pressed resulting in the form being submitted.

Return values

bool	true if a cancel button has been pressed

Reimplemented in base_moodleform.

◆ is_submitted()

moodleform::is_submitted ( )

inherited

Check that form was submitted.

Does not check validity of submitted data.

Return values

bool	true if form properly submitted

◆ is_validated()

moodleform::is_validated ( )

inherited

Check that form data is valid.

You should almost always use this, rather than validate_defined_fields

Return values

bool	true if form data valid

◆ mock_generate_submit_keys()

static moodleform::mock_generate_submit_keys ( $data = [] )

staticinherited

Used by tests to generate valid submit keys for moodle forms that are submitted with ajax data.

Exceptions

moodle_exception If called outside unit test environment

Parameters

array $data Existing form data you wish to add the keys to.

Return values

array

◆ mock_submit()

static moodleform::mock_submit	(	$simulatedsubmitteddata,
		$simulatedsubmittedfiles = `array()`,
		$method = `'post'`,
		$formidentifier = `null`
	)

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.

Parameters

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.

◆ moodleform()

moodleform::moodleform	(	$action = `null`,
		$customdata = `null`,
		$method = `'post'`,
		$target = `''`,
		$attributes = `null`,
		$editable = `true`
	)

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:: since Moodle 3.1

◆ moodleform_mod()

moodleform_mod::moodleform_mod	(	$current,
		$section,
		$cm,
		$course
	)

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:: since Moodle 3.1

◆ no_submit_button_pressed()

moodleform::no_submit_button_pressed ( )

inherited

Checks if button pressed is not for submitting the form.

@staticvar bool $nosubmit keeps track of no submit button

Return values

bool

◆ optional_param()

moodleform::optional_param	(	$name,
		$default,
		$type
	)

inherited

Checks if a parameter was passed in the previous form submission.

Parameters

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

Return values

mixed

◆ plugin_extend_coursemodule_validation()

moodleform_mod::plugin_extend_coursemodule_validation ( $data )

protectedinherited

Extend the validation function from any other plugin.

Parameters

stdClass $data The form data.

Return values

array::$errors The list of errors keyed by element name.

◆ render()

moodleform::render ( )

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.

Return values

string HTML code for the form

◆ repeat_elements()

moodleform::repeat_elements	(	$elementobjs,
		$repeats,
		$options,
		$repeathiddenname,
		$addfieldsname,
		$addfieldsno = `5`,
		$addstring = `null`,
		$addbuttoninside = `false`
	)

inherited

Method to add a repeating group of elements to a form.

Parameters

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.

Return values

int	no of repeats of element in this page

◆ repeat_elements_fix_clone()

moodleform::repeat_elements_fix_clone	(		$i,
			$elementclone,
		&	$namecloned
	)

inherited

Helper used by repeat_elements().

Parameters

int	$i	the index of this element.
HTML_QuickForm_element	$elementclone
array	$namecloned	array of names

◆ save_file()

moodleform::save_file	(	$elname,
		$pathname,
		$override = `false`
	)

inherited

Save file to standard filesystem.

Parameters

string	$elname	name of element
string	$pathname	full path name of file
bool	$override	override file if exists

Return values

bool success

◆ save_files()

moodleform::save_files ( $destination )

inherited

Save verified uploaded files into directory.

Upload process can be customised from definition()

Deprecated:: since Moodle 2.0

Todo:: MDL-31294 remove this api

See also: moodleform::save_stored_file(); moodleform::save_file()

Parameters

string $destination path where file should be stored

Return values

bool	Always false

◆ save_stored_file()

moodleform::save_stored_file	(	$elname,
		$newcontextid,
		$newcomponent,
		$newfilearea,
		$newitemid,
		$newfilepath = `'/'`,
		$newfilename = `null`,
		$overwrite = `false`,
		$newuserid = `null`
	)

inherited

Save file to local filesystem pool.

Parameters

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

Return values

mixed stored_file object or false if error; may throw exception if duplicate found

◆ save_temp_file()

moodleform::save_temp_file ( $elname )

inherited

Returns a temporary file, do not forget to delete after not needed any more.

Parameters

string $elname name of the elmenet

Return values

string|bool either string or false

◆ set_data()

mod_lti_mod_form::set_data ( $defaultvalues )

Sets the current values handled by services in case of update.

Parameters

object $defaultvalues default values to populate the form with.

Reimplemented from moodleform_mod.

◆ set_display_vertical()

moodleform::set_display_vertical ( )

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

◆ set_initial_dirty_state()

moodleform::set_initial_dirty_state ( $state = false )

inherited

Set the initial 'dirty' state of the form.

Parameters

bool $state

Since: Moodle 3.7.1

◆ standard_intro_elements()

moodleform_mod::standard_intro_elements ( $customlabel = null )

protectedinherited

Add an editor for an activity's introduction field.

Parameters

null $customlabel Override default label for editor

Exceptions

coding_exception

◆ validate_defined_fields()

moodleform::validate_defined_fields ( $validateonnosubmit = false )

inherited

Validate the form.

You almost always want to call is_validated 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,

Parameters

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

Return values

bool	true if form data valid

◆ validate_draft_files()

moodleform::validate_draft_files ( )

protectedinherited

Internal method.

Validates filepicker and filemanager files if they are set as required fields. Also, sets the error message if encountered one.

Return values

bool|array with errors

◆ validation()

moodleform_mod::validation	(	$data,
		$files
	)

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.

Parameters

array	$data	array of ("fieldname"=>value) of submitted data
array	$files	array of uploaded files "element_name"=>tmp_file_path

Return values

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 from moodleform.

Reimplemented in mod_assign_mod_form, mod_choice_mod_form, mod_data_mod_form, mod_feedback_mod_form, mod_folder_mod_form, mod_forum_mod_form, mod_h5pactivity_mod_form, mod_imscp_mod_form, mod_lesson_mod_form, mod_quiz_mod_form, mod_resource_mod_form, mod_scorm_mod_form, mod_url_mod_form, and mod_workshop_mod_form.

Member Data Documentation

◆ $_cm

mixed moodleform_mod::$_cm

protectedinherited

Course module record of the module that is being updated.

Will be null if this is an 'add' form and not an update one.

◆ $_instance

mixed moodleform_mod::$_instance

protectedinherited

Instance of the module that is being updated.

This is the id of the {prefix}{modulename} record. Can be used in form definition. Will be "" if this is an 'add' form and not an update one.

◆ $_section

int moodleform_mod::$_section

protectedinherited

Section of course that module instance will be put in or is in.

This is always the section number itself (column 'section' from 'course_sections' table).

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

mod/lti/mod_form.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ _get_post_params()

◆ _process_submission()

◆ _validate_files()

◆ add_action_buttons() [1/2]

◆ add_action_buttons() [2/2]

◆ add_checkbox_controller()

◆ add_completion_rules()

◆ add_intro_editor()

◆ add_rating_settings()

◆ after_definition()

◆ apply_admin_defaults()

◆ apply_admin_locked_flags()

◆ completion_rule_enabled()

◆ data_postprocessing()

◆ data_preprocessing()

◆ definition()

◆ definition_after_data()

◆ display()

◆ focus()

◆ get_context()

◆ get_course()

◆ get_coursemodule()

◆ get_current()

◆ get_data()

◆ get_draft_files()

◆ get_features()

◆ get_file_content()

◆ get_form_identifier()

◆ get_instance()

◆ get_js_module()

◆ get_new_filename()

◆ get_section()

◆ get_submitted_data()

◆ init_javascript_enhancement()

◆ is_cancelled()

◆ is_submitted()

◆ is_validated()

◆ mock_generate_submit_keys()

◆ mock_submit()

◆ moodleform()

◆ moodleform_mod()

◆ no_submit_button_pressed()

◆ optional_param()

◆ plugin_extend_coursemodule_validation()

◆ render()

◆ repeat_elements()

◆ repeat_elements_fix_clone()

◆ save_file()

◆ save_files()

◆ save_stored_file()

◆ save_temp_file()

◆ set_data()

◆ set_display_vertical()

◆ set_initial_dirty_state()

◆ standard_intro_elements()

◆ validate_defined_fields()

◆ validate_draft_files()

◆ validation()

Member Data Documentation

◆ $_cm

◆ $_instance

◆ $_section