assign_override_form Class Reference

Form for editing settings overrides. More...

Inheritance diagram for assign_override_form:

Public Member Functions
	__construct ($submiturl, $cm, $assign, $context, $groupmode, $override, $selecteduserid=null)
	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_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.
	definition_after_data ()
	Override definition after data has been set.
	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_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.
	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)
	Validate the submitted form data.

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.
	after_definition ()
	After definition hook.
	definition ()
	Define this form - called by the parent constructor.
	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
object	$assign
	the assign settings object.
object	$cm
	course module object.
context	$context
	the assign context.
int	$groupid
	groupid, if provided.
bool	$groupmode
	editing group override (true) or user override (false).
int	$selecteduserid
	selecteduserid, if provided.
int	$sortorder
	sortorder, if provided.
int	$userid
	userid, if provided.

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

Detailed Description

Form for editing settings overrides.

Copyright

2016 Ilya Tregubov

License

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

Constructor & Destructor Documentation

__construct()

assign_override_form::__construct	(		$submiturl,
			$cm,
			$assign,
			$context,
			$groupmode,
			$override,
			$selecteduserid = null )

Constructor.

Parameters

moodle_url	$submiturl	the form action URL.
object	$cm	course module object.
object	$assign	the assign settings object.
object	$context	the assign context.
bool	$groupmode	editing group override (true) or user override (false).
object	$override	the override being edited, if it already exists.
int	$selecteduserid	the user selected in the form, if any.

Reimplemented from moodleform.

Member Function Documentation

definition()

assign_override_form::definition ( )

protected

Define this form - called by the parent constructor.

Reimplemented from moodleform.

definition_after_data()

assign_override_form::definition_after_data

(

)

Override definition after data has been set.

The value of date time selector will be lost in a POST request, if the selector is disabled. So, we need to set the value again.

return void

Reimplemented from moodleform.

validation()

assign_override_form::validation	(		$data,
			$files )

Validate the submitted form data.

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

Reimplemented from moodleform.

---

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

• mod/assign/override_form.php