core_completion_edit_base_form Class Reference

Base form for changing completion rules. More...

Inheritance diagram for core_completion_edit_base_form:

Public Member Functions
	_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.
	definition ()
	Form definition.
	definition_after_data ()
	Dummy stub method - override if you need to setup the form depending on current values.
	display ()
	Print html form.
	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.
	has_custom_completion_rules ()
	Returns if this form has custom completion rules.
	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)
	Form 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_custom_completion_rules ()
	If all selected modules are of the same module type, adds custom completion rules from this module type.
	after_definition ()
	After definition hook.
	completion_rule_enabled ($data)
	Checks if at least one of the custom completion rules is enabled.
	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.
	get_module_form ()
	Returns an instance of component-specific module form for the first selected module.
	get_module_names ()
	Returns list of types of selected module types.
	get_modules_with_hidden_rules ()
	Returns list of modules that have automatic completion rules that are not shown on this form (because they are not present in at least one other selected module).
	support_grades ()
	Returns true if all selected modules support grading.
	support_views ()
	Returns true if all selected modules support tracking view.
	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
moodleform_mod	$_moduleform = null
	Do not use directly, call $this->get_module_form()
bool null	$_validated = null
	stores the validation result of this form or null if not yet validated
stdClass	$course
bool	$hascustomrules = false

Detailed Description

Base form for changing completion rules.

Used in bulk editing activity completion and editing default activity completion

Copyright

2017 Marina Glancy

License

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

Member Function Documentation

add_custom_completion_rules()

core_completion_edit_base_form::add_custom_completion_rules ( )

protected

If all selected modules are of the same module type, adds custom completion rules from this module type.

Return values

array

completion_rule_enabled()

core_completion_edit_base_form::completion_rule_enabled ( $data )

protected

Checks if at least one of the custom completion rules is enabled.

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

definition()

core_completion_edit_base_form::definition

(

)

Form definition.

Reimplemented from moodleform.

Reimplemented in core_completion_bulkedit_form, and core_completion_defaultedit_form.

get_data()

core_completion_edit_base_form::get_data

(

)

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

Return values

object

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

Reimplemented from moodleform.

get_module_form()

core_completion_edit_base_form::get_module_form ( )

abstractprotected

Returns an instance of component-specific module form for the first selected module.

Return values

moodleform_mod|null

Reimplemented in core_completion_bulkedit_form, and core_completion_defaultedit_form.

get_module_names()

core_completion_edit_base_form::get_module_names ( )

abstractprotected

Returns list of types of selected module types.

Return values

array

modname=>modfullname

Reimplemented in core_completion_bulkedit_form, and core_completion_defaultedit_form.

get_modules_with_hidden_rules()

core_completion_edit_base_form::get_modules_with_hidden_rules ( )

protected

Returns list of modules that have automatic completion rules that are not shown on this form (because they are not present in at least one other selected module).

Return values

array

has_custom_completion_rules()

core_completion_edit_base_form::has_custom_completion_rules

(

)

Returns if this form has custom completion rules.

This is only possible if all selected modules have the same module type and this module type supports custom completion rules

Return values

bool

support_grades()

core_completion_edit_base_form::support_grades ( )

protected

Returns true if all selected modules support grading.

Return values

bool

support_views()

core_completion_edit_base_form::support_views ( )

protected

Returns true if all selected modules support tracking view.

Return values

bool

validation()

core_completion_edit_base_form::validation	(		$data,
			$files )

Form validation.

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

---

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

• completion/classes/edit_base_form.php