Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
tool_dataprivacy\form\purpose Class Reference

Data purpose form. More...

Inheritance diagram for tool_dataprivacy\form\purpose:
core\form\persistent moodleform

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_checkbox_controller ($groupid, $text=null, $attributes=null, $originalValue=0)
 Adds a link/button that controls the checked state of a group of checkboxes. More...
 
 definition ()
 Define the form - called by parent constructor. More...
 
 definition_after_data ()
 Dummy stub method - override if you need to setup the form depending on current values. More...
 
 display ()
 Print html form. More...
 
 filter_data_for_persistent ($data)
 Converts fields. More...
 
 focus ($name=NULL)
 To autofocus on first form element or first element with error. More...
 
 get_data ()
 Get form data. More...
 
 get_file_content ($elname)
 Get content of uploaded file. More...
 
 get_new_filename ($elname=null)
 Returns name of uploaded file. More...
 
 get_role_overrides_from_data (\stdClass $data)
 Fetch the role override data from the list of submitted data. More...
 
 get_submitted_data ()
 Get the submitted form 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...
 
 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 ($data)
 Load in existing data as form defaults. 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...
 
 validate_defined_fields ($validateonnosubmit=false)
 Validate the form. More...
 
 validation ($data, $files)
 Form 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_field (\stdClass $data)
 Add a fieldset to the current form. More...
 
 add_override_fields ()
 Handle addition of relevant repeated element fields for role overrides.
 
 after_definition ()
 After definition hook. More...
 
 convert_existing_data_to_values (\stdClass $data)
 Normalise any values stored in existing data. More...
 
 extra_validation ($data, $files, array &$errors)
 Define extra validation mechanims. More...
 
 get_default_data ()
 Get the default data. 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...
 
 get_lawful_base_field (string $prefix='')
 Get the mform field for lawful bases. More...
 
 get_persistent ()
 Return the persistent object associated with this form instance. More...
 
 get_protected_field (string $prefix='')
 Get the mform field for the protected flag. More...
 
 get_retention_period_fields (string $prefix='')
 Get the retention period fields. More...
 
 get_role_field (string $prefix='')
 Get the field for the role name. More...
 
 get_role_override_id (string $prefix='')
 Get the field for the role name. More...
 
 get_sensitive_base_field (string $prefix='')
 Get the mform field for sensitive bases. More...
 
 validate_draft_files ()
 Internal method. More...
 

Static Protected Member Functions

static convert_fields (\stdClass $data)
 Converts data to data suitable for storage. More...
 
static convert_fields (stdClass $data)
 Convert some fields. More...
 

Protected Attributes

array $_ajaxformdata
 submitted form data when using mforms with ajax
 
array $_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
 
array $existingoverrides = []
 The list of current overrides.
 

Static Protected Attributes

static array $fieldstoremove = array('submitbutton')
 Fields to remove when getting the final data.
 
static array $foreignfields = array()
 Fields to remove from the persistent validation.
 
static string $persistentclass = 'tool_dataprivacy\\purpose'
 The persistent class.
 

Detailed Description

Data purpose form.

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

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$methodname 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$fileslist of files to be validated
Return values
bool|arraySuccess or an array of errors

◆ add_action_buttons()

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$cancelwhether to show cancel button, default true
string$submitlabellabel for submit button, defaults to get_string('savechanges')

Reimplemented in tool_uploadcourse_step2_form, and core_contentbank\form\edit_content.

◆ 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$groupidThe id of the group of advcheckboxes this element controls
string$textThe text of the link. Defaults to selectallornone ("select all/none")
array$attributesassociative array of HTML attributes
int$originalValueThe original general state of the checkboxes before the user first clicks this element

◆ add_field()

tool_dataprivacy\form\purpose::add_field ( \stdClass  $data)
protected

Add a fieldset to the current form.

Parameters
stdClass$data

◆ after_definition()

core\form\persistent::after_definition ( )
protectedinherited

After definition hook.

Automatically try to set the types of simple fields using the persistent properties definition. This only applies to hidden, text and url types. Groups are also ignored as they are most likely custom.

Return values
void

Reimplemented from moodleform.

◆ convert_existing_data_to_values()

tool_dataprivacy\form\purpose::convert_existing_data_to_values ( \stdClass  $data)
protected

Normalise any values stored in existing data.

Parameters
stdClass$data
Return values
stdClass

◆ convert_fields() [1/2]

static tool_dataprivacy\form\purpose::convert_fields ( \stdClass  $data)
staticprotected

Converts data to data suitable for storage.

Parameters
stdClass$data
Return values
stdClass

◆ convert_fields() [2/2]

static core\form\persistent::convert_fields ( stdClass  $data)
staticprotectedinherited

Convert some fields.

Parameters
stdClass$dataThe whole data set.
Return values
stdClassThe amended data set.

Reimplemented in tool_lp\form\competency, and tool_lp\form\competency_framework.

◆ definition()

tool_dataprivacy\form\purpose::definition ( )

Define the form - called by parent constructor.

Reimplemented from moodleform.

◆ definition_after_data()

moodleform::definition_after_data ( )
inherited

◆ display()

moodleform::display ( )
inherited

Print html form.

Reimplemented in base_moodleform, cohort_upload_form, and mod_feedback_complete_form.

◆ extra_validation()

tool_dataprivacy\form\purpose::extra_validation (   $data,
  $files,
array &  $errors 
)
protected

Define extra validation mechanims.

Parameters
stdClass$dataData to validate.
array$filesArray of files.
array$errorsCurrently reported errors.
Return values
arrayof additional errors, or overridden errors.

Reimplemented from core\form\persistent.

◆ filter_data_for_persistent()

tool_dataprivacy\form\purpose::filter_data_for_persistent (   $data)

Converts fields.

Parameters
stdClass$data
Return values
stdClass

Reimplemented from core\form\persistent.

◆ focus()

moodleform::focus (   $name = NULL)
inherited

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

Parameters
string$nameif this is set then the focus is forced to a field with this name
Return values
stringjavascript to select form element with first error or first element if no errors. Use this as a parameter when calling print_header

◆ get_data()

core\form\persistent::get_data ( )
inherited

Get form data.

Conveniently removes non-desired properties and add the ID property.

Return values
object|null

Reimplemented from moodleform.

◆ get_default_data()

tool_dataprivacy\form\purpose::get_default_data ( )
protected

Get the default data.

Return values
stdClass

Reimplemented from core\form\persistent.

◆ 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$elnamename of element
Return values
array|bool|null

◆ get_file_content()

moodleform::get_file_content (   $elname)
inherited

Get content of uploaded file.

Parameters
string$elnamename of file upload element
Return values
string|boolfalse 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
stringform identifier.

Reimplemented in enrol_self_enrol_form, and mod_assign_grade_form.

◆ get_js_module()

static moodleform::get_js_module ( )
staticinherited

Returns a JS module definition for the mforms JS.

Return values
array

◆ get_lawful_base_field()

tool_dataprivacy\form\purpose::get_lawful_base_field ( string  $prefix = '')
protected

Get the mform field for lawful bases.

Parameters
string$prefixThe prefix to apply to the field
Return values
stdClass

◆ get_new_filename()

moodleform::get_new_filename (   $elname = null)
inherited

Returns name of uploaded file.

Parameters
string$elnamefirst element if null
Return values
string|boolfalse in case of failure, string if ok

◆ get_persistent()

core\form\persistent::get_persistent ( )
finalprotectedinherited

Return the persistent object associated with this form instance.

Return values
core::persistent

◆ get_protected_field()

tool_dataprivacy\form\purpose::get_protected_field ( string  $prefix = '')
protected

Get the mform field for the protected flag.

Parameters
string$prefixThe prefix to apply to the field
Return values
stdClass

◆ get_retention_period_fields()

tool_dataprivacy\form\purpose::get_retention_period_fields ( string  $prefix = '')
protected

Get the retention period fields.

Parameters
string$prefixThe name of the main field, and prefix for the subfields.
Return values
stdClass

◆ get_role_field()

tool_dataprivacy\form\purpose::get_role_field ( string  $prefix = '')
protected

Get the field for the role name.

Parameters
string$prefixThe prefix to apply to the field
Return values
stdClass

◆ get_role_override_id()

tool_dataprivacy\form\purpose::get_role_override_id ( string  $prefix = '')
protected

Get the field for the role name.

Parameters
string$prefixThe prefix to apply to the field
Return values
stdClass

◆ get_role_overrides_from_data()

tool_dataprivacy\form\purpose::get_role_overrides_from_data ( \stdClass  $data)

Fetch the role override data from the list of submitted data.

Parameters
stdClass$dataThe complete set of processed data
Return values
stdClass[]The list of overrides

◆ get_sensitive_base_field()

tool_dataprivacy\form\purpose::get_sensitive_base_field ( string  $prefix = '')
protected

Get the mform field for sensitive bases.

Parameters
string$prefixThe prefix to apply to the field
Return values
stdClass

◆ get_submitted_data()

core\form\persistent::get_submitted_data ( )
inherited

Get the submitted form data.

Conveniently removes non-desired properties.

Return values
object|null

Reimplemented from moodleform.

◆ 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$elementform element for which Javascript needs to be initalized
string$enhancementwhich init function should be called
array$optionsoptions passed to javascript
array$stringsstrings 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
booltrue 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
booltrue 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
booltrue 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_exceptionIf called outside unit test environment
Parameters
array$dataExisting 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$simulatedsubmitteddataAn associative array of form values (same format as $_POST).
array$simulatedsubmittedfilesAn associative array of files uploaded (same format as $_FILES). Can be omitted.
string$method'post' or 'get', defaults to 'post'.
null$formidentifierthe 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

◆ 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$namethe name of the page parameter we want
mixed$defaultthe default value to return if nothing is found
string$typeexpected type of parameter
Return values
mixed

◆ 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
stringHTML 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$elementobjsArray of elements or groups of elements that are to be repeated
int$repeatsno of times to repeat elements initially
array$optionsa 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$repeathiddennamename for hidden element storing no of repeats in this form
string$addfieldsnamename for button to add more fields
int$addfieldsnohow many fields to add at a time
string$addstringname of button, {no} is replaced by no of blanks that will be added.
bool$addbuttoninsideif true, don't call closeHeaderBefore($addfieldsname). Default false.
Return values
intno 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$ithe index of this element.
HTML_QuickForm_element$elementclone
array$nameclonedarray of names

◆ save_file()

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

Save file to standard filesystem.

Parameters
string$elnamename of element
string$pathnamefull path name of file
bool$overrideoverride file if exists
Return values
boolsuccess

◆ 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$destinationpath where file should be stored
Return values
boolAlways 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$elnamename of element
int$newcontextidid of context
string$newcomponentname of the component
string$newfileareaname of file area
int$newitemiditem id
string$newfilepathpath of file where it get stored
string$newfilenameuse specified filename, if not specified name of uploaded file used
bool$overwriteoverwrite file if exists
int$newuseridnew userid if required
Return values
mixedstored_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$elnamename of the elmenet
Return values
string|booleither string or false

◆ set_data()

tool_dataprivacy\form\purpose::set_data (   $data)

Load in existing data as form defaults.

Usually new entry defaults are stored directly in form definition (new entry form); this function is used to load in data where values already exist and data is being edited (edit entry form).

Parameters
stdClass$data

Reimplemented from moodleform.

◆ 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

◆ 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$validateonnosubmitoptional, 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
booltrue 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|arraywith errors

◆ validation()

core\form\persistent::validation (   $data,
  $files 
)
finalinherited

Form validation.

If you need extra validation, use self::extra_validation().

Parameters
array$data
array$files
Return values
array

Reimplemented from moodleform.


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