core_grades\form\add_category Class Reference

Inheritance diagram for core_grades\form\add_category:

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.
	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 ()
	This method implements changes to the form that need to be made once the form data is 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.
	process_dynamic_submission ()
	Process the form submission, used if form was submitted via AJAX.
	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_data_for_dynamic_submission ()
	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.

Public Attributes
object	$gpr
	Grade plugin return tracking object.

Protected Member Functions
	_get_post_params ()
	Internal method - should not be used anywhere.
	after_definition ()
	After definition hook.
	check_access_for_dynamic_submission ()
	Check if current user has access to this form, otherwise throw exception.
	definition ()
	Form definition.
	get_array_value_by_keys (array $array, array $keys)
	Returns an element of multi-dimensional array given the list of keys.
	get_context_for_dynamic_submission ()
	Return form context.
	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_page_url_for_dynamic_submission ()
	Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX.
	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

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

Member Function Documentation

check_access_for_dynamic_submission()

core_grades\form\add_category::check_access_for_dynamic_submission ( )

protected

Check if current user has access to this form, otherwise throw exception.

Return values

void

Exceptions

required_capability_exception

Reimplemented from core_form\dynamic_form.

definition()

core_grades\form\add_category::definition ( )

protected

Form definition.

Return values

void

Exceptions

coding_exception
dml_exception
moodle_exception

Reimplemented from moodleform.

definition_after_data()

core_grades\form\add_category::definition_after_data

(

)

This method implements changes to the form that need to be made once the form data is set.

Reimplemented from moodleform.

get_context_for_dynamic_submission()

core_grades\form\add_category::get_context_for_dynamic_submission ( )

protected

Return form context.

Return values

context

Reimplemented from core_form\dynamic_form.

get_page_url_for_dynamic_submission()

core_grades\form\add_category::get_page_url_for_dynamic_submission ( )

protected

Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX.

Return values

moodle_url

Exceptions

moodle_exception

Reimplemented from core_form\dynamic_form.

process_dynamic_submission()

core_grades\form\add_category::process_dynamic_submission

(

)

Process the form submission, used if form was submitted via AJAX.

Return values

array

Exceptions

moodle_exception

Reimplemented from core_form\dynamic_form.

set_data_for_dynamic_submission()

core_grades\form\add_category::set_data_for_dynamic_submission

(

)

Load in existing data as form defaults.

Return values

void

Reimplemented from core_form\dynamic_form.

validation()

core_grades\form\add_category::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.

Member Data Documentation

$gpr

object core_grades\form\add_category::$gpr

Grade plugin return tracking object.

$gpr

---

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

• grade/classes/form/add_category.php