Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
profile_field_textarea Class Reference

Class profile_field_textarea. More...

Inheritance diagram for profile_field_textarea:

Public Member Functions

 display_data ()
 Display the data for this field.
 
 edit_field_add ($mform)
 Adds elements for this field type to the edit form.
 
 edit_load_user_data ($user)
 Load user data for this profile field, ready for editing.
 
 edit_save_data_preprocess ($data, $datarecord)
 Process incoming data for the field.
 
 get_field_properties ()
 Return the field type and null properties.
 
 is_user_object_data ()
 Overwrite base class method, data in this field type is potentially too large to be included in the user object.
 

Detailed Description

Class profile_field_textarea.

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

Member Function Documentation

◆ display_data()

profile_field_textarea::display_data ( )

Display the data for this field.

Return values
string

◆ edit_field_add()

profile_field_textarea::edit_field_add ( $mform)

Adds elements for this field type to the edit form.

Parameters
moodleform$mform

◆ edit_load_user_data()

profile_field_textarea::edit_load_user_data ( $user)

Load user data for this profile field, ready for editing.

Parameters
stdClass$user

◆ edit_save_data_preprocess()

profile_field_textarea::edit_save_data_preprocess ( $data,
$datarecord )

Process incoming data for the field.

Parameters
stdClass$data
stdClass$datarecord
Return values
mixed|stdClass

◆ get_field_properties()

profile_field_textarea::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

◆ is_user_object_data()

profile_field_textarea::is_user_object_data ( )

Overwrite base class method, data in this field type is potentially too large to be included in the user object.

Return values
bool

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