Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/customfield/field/select/classes/ -> field_controller.php (source)

[Source view]

Differences Between: [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]

Class field

Copyright: 2018 David Matamoros <davidmc@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 146 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

field_controller:: (7 methods):
  config_form_definition()
  get_options_array()
  get_options()
  config_form_validation()
  supports_course_grouping()
  course_grouping_format_values()
  parse_value()


Class: field_controller  - X-Ref

Class field

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

param: \MoodleQuickForm $mform

get_options_array(\core_customfield\field_controller $field)   X-Ref
Returns the options available as an array.

param: \core_customfield\field_controller $field
return: array

get_options()   X-Ref
Return configured field options

return: array

config_form_validation(array $data, $files = array()   X-Ref
Validate the data from the config form.
Sub classes must reimplement it.

param: array $data from the add/edit profile field form
param: array $files
return: array associative array of error messages

supports_course_grouping()   X-Ref
Does this custom field type support being used as part of the block_myoverview
custom field grouping?

return: bool

course_grouping_format_values($values)   X-Ref
If this field supports course grouping, then this function needs overriding to
return the formatted values for this.

param: array $values the used values that need formatting
return: array

parse_value(string $value)   X-Ref
Locate the value parameter in the field options array, and return it's index

param: string $value
return: int