Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
profile_field_text Class Reference

Text profile field. More...

Inheritance diagram for profile_field_text:

Public Member Functions

 convert_external_data ($data)
 Convert external data (csv file) from value to key for processing later by edit_save_data_preprocess.
 
 display_data ()
 Overwrite the base class to display the data for this field.
 
 edit_field_add ($mform)
 Add fields for editing a text profile field.
 
 edit_save_data_preprocess ($data, $datarecord)
 Process the data before it gets saved in database.
 
 get_field_properties ()
 Return the field type and null properties.
 

Detailed Description

Text profile field.

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

Member Function Documentation

◆ convert_external_data()

profile_field_text::convert_external_data ( $data)

Convert external data (csv file) from value to key for processing later by edit_save_data_preprocess.

Parameters
string$data
Return values
string|null

◆ edit_field_add()

profile_field_text::edit_field_add ( $mform)

Add fields for editing a text profile field.

Parameters
moodleform$mform

◆ edit_save_data_preprocess()

profile_field_text::edit_save_data_preprocess ( $data,
$datarecord )

Process the data before it gets saved in database.

Parameters
string | null$data
stdClass$datarecord
Return values
string|null

◆ get_field_properties()

profile_field_text::get_field_properties ( )

Return the field type and null properties.

This will be used for validating the data submitted by a user.

Return values
arraythe param type and null property
Since
Moodle 3.2

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