Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/customfield/field/textarea/classes/ -> data_controller.php (source)

[Source view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403]

Customfields textarea plugin

Copyright: 2018 Daniel Neis Araujo <daniel@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 209 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

data_controller:: (11 methods):
  datafield()
  value_editor_options()
  get_form_element_name()
  instance_form_definition()
  instance_form_save()
  instance_form_before_set_data()
  is_empty()
  is_unique()
  delete()
  get_default_value()
  export_value()


Class: data_controller  - X-Ref

Class data

datafield()   X-Ref
Return the name of the field where the information is stored

return: string

value_editor_options()   X-Ref
Options for the editor

return: array

get_form_element_name()   X-Ref
Returns the name of the field to be used on HTML forms.

return: string

instance_form_definition(\MoodleQuickForm $mform)   X-Ref
Add fields for editing a textarea field.

param: \MoodleQuickForm $mform

instance_form_save(\stdClass $datanew)   X-Ref
Saves the data coming from form

param: \stdClass $datanew data coming from the form

instance_form_before_set_data(\stdClass $instance)   X-Ref
Prepares the custom field data related to the object to pass to mform->set_data() and adds them to it

This function must be called before calling $form->set_data($object);

param: \stdClass $instance the entity that has custom fields, if 'id' attribute is present the custom

is_empty($value)   X-Ref
Checks if the value is empty, overriding the base method to ensure it's the "text" element of our value being compared

param: mixed $value
return: bool

is_unique($value)   X-Ref
Checks if the value is unique, overriding the base method to ensure it's the "text" element of our value being compared

param: mixed $value
return: bool

delete()   X-Ref
Delete data

return: bool

get_default_value()   X-Ref
Returns the default value as it would be stored in the database (not in human-readable format).

return: mixed

export_value()   X-Ref
Returns value in a human-readable format

return: mixed|null value or null if empty