Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Attributes | List of all members
profile_field_text Class Reference

Class profile_field_text. More...

Inheritance diagram for profile_field_text:
profile_field_base

Public Member Functions

 display_data ()
 Overwrite the base class to display the data for this field. More...
 
 edit_after_data ($mform)
 Tweaks the edit form. More...
 
 edit_field ($mform)
 Print out the form field in the edit profile page. More...
 
 edit_field_add ($mform)
 Add fields for editing a text profile field. More...
 
 edit_field_set_default ($mform)
 Sets the default data for the field in the form object. More...
 
 edit_field_set_locked ($mform)
 HardFreeze the field if locked. More...
 
 edit_field_set_required ($mform)
 Sets the required flag for the field in the form object. More...
 
 edit_load_user_data ($user)
 Loads a user object with data for this field ready for the edit profile form. More...
 
 edit_save_data ($usernew)
 Saves the data coming from form. More...
 
 edit_save_data_preprocess ($data, $datarecord)
 Hook for child classess to process the data before it gets saved in database. More...
 
 edit_validate_field ($usernew)
 Validate the form field from profile page. More...
 
 get_category_name ()
 Returns the name of the profile category where this field is. More...
 
 get_field_config_for_external ()
 Return the field settings suitable to be exported via an external function. More...
 
 get_field_properties ()
 Return the field type and null properties. More...
 
 is_editable ()
 Check if the field data is editable for the current user This method should not generally be overwritten by child classes. More...
 
 is_empty ()
 Check if the field data is considered empty. More...
 
 is_locked ()
 Check if the field is locked on the edit profile page.
 
 is_required ()
 Check if the field is required on the edit profile page.
 
 is_signup_field ()
 Check if the field should appear on the signup page.
 
 is_unique ()
 Check if the field data should be unique.
 
 is_user_object_data ()
 Check if the field data should be loaded into the user object By default it is, but for field types where the data may be potentially large, the child class should override this and return false. More...
 
 is_visible ()
 Check if the field data is visible to the current user.
 
 load_data ()
 Accessor method: Load the field record and user data associated with the object's fieldid and userid.
 
 profile_field_base ($fieldid=0, $userid=0)
 Old syntax of class constructor. More...
 
 set_category_name ($categoryname)
 Set the name for the profile category where this field is. More...
 
 set_field ($field)
 Sets the field object and default data and format into $this->data and $this->dataformat. More...
 
 set_fieldid ($fieldid)
 Accessor method: set the fieldid for this instance.
 
 set_user_data ($data, $dataformat)
 Sets user id and user data for the field. More...
 
 set_userid ($userid)
 Accessor method: set the userid for this instance.
 

Public Attributes

mixed $data
 
string $dataformat
 
stdClass $field
 
int $fieldid
 
string $inputname
 
int $userid
 

Protected Attributes

string $categoryname
 name of the user profile category
 

Detailed Description

Class profile_field_text.

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

Member Function Documentation

◆ display_data()

profile_field_text::display_data ( )

Overwrite the base class to display the data for this field.

Reimplemented from profile_field_base.

◆ edit_after_data()

profile_field_base::edit_after_data (   $mform)
inherited

Tweaks the edit form.

Parameters
moodleform$mforminstance of the moodleform class
Return values
bool

◆ edit_field()

profile_field_base::edit_field (   $mform)
inherited

Print out the form field in the edit profile page.

Parameters
moodleform$mforminstance of the moodleform class
Return values
bool

◆ edit_field_add()

profile_field_text::edit_field_add (   $mform)

Add fields for editing a text profile field.

Parameters
moodleform$mform

Reimplemented from profile_field_base.

◆ edit_field_set_default()

profile_field_base::edit_field_set_default (   $mform)
inherited

Sets the default data for the field in the form object.

Parameters
moodleform$mforminstance of the moodleform class

Reimplemented in profile_field_menu.

◆ edit_field_set_locked()

profile_field_base::edit_field_set_locked (   $mform)
inherited

HardFreeze the field if locked.

Parameters
moodleform$mforminstance of the moodleform class

Reimplemented in profile_field_menu.

◆ edit_field_set_required()

profile_field_base::edit_field_set_required (   $mform)
inherited

Sets the required flag for the field in the form object.

Parameters
moodleform$mforminstance of the moodleform class

◆ edit_load_user_data()

profile_field_base::edit_load_user_data (   $user)
inherited

Loads a user object with data for this field ready for the edit profile form.

Parameters
stdClass$usera user object

Reimplemented in profile_field_menu, and profile_field_textarea.

◆ edit_save_data()

profile_field_base::edit_save_data (   $usernew)
inherited

Saves the data coming from form.

Parameters
stdClass$usernewdata coming from the form
Return values
mixedreturns data id if success of db insert/update, false on fail, 0 if not permitted

◆ edit_save_data_preprocess()

profile_field_base::edit_save_data_preprocess (   $data,
  $datarecord 
)
inherited

Hook for child classess to process the data before it gets saved in database.

Parameters
stdClass$data
stdClass$datarecordThe object that will be used to save the record
Return values
mixed

Reimplemented in profile_field_menu, profile_field_textarea, and profile_field_datetime.

◆ edit_validate_field()

profile_field_base::edit_validate_field (   $usernew)
inherited

Validate the form field from profile page.

Parameters
stdClass$usernew
Return values
stringcontains error message otherwise null

◆ get_category_name()

profile_field_base::get_category_name ( )
inherited

Returns the name of the profile category where this field is.

Return values
string

◆ get_field_config_for_external()

profile_field_base::get_field_config_for_external ( )
inherited

Return the field settings suitable to be exported via an external function.

By default it return all the field settings.

Return values
arrayall the settings
Since
Moodle 3.2

◆ 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

Reimplemented from profile_field_base.

◆ is_editable()

profile_field_base::is_editable ( )
inherited

Check if the field data is editable for the current user This method should not generally be overwritten by child classes.

Return values
bool

◆ is_empty()

profile_field_base::is_empty ( )
inherited

Check if the field data is considered empty.

Reimplemented in profile_field_datetime.

◆ is_user_object_data()

profile_field_base::is_user_object_data ( )
inherited

Check if the field data should be loaded into the user object By default it is, but for field types where the data may be potentially large, the child class should override this and return false.

Return values
bool

Reimplemented in profile_field_textarea.

◆ profile_field_base()

profile_field_base::profile_field_base (   $fieldid = 0,
  $userid = 0 
)
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:
since Moodle 3.1

◆ set_category_name()

profile_field_base::set_category_name (   $categoryname)
inherited

Set the name for the profile category where this field is.

Parameters
string$categoryname

◆ set_field()

profile_field_base::set_field (   $field)
inherited

Sets the field object and default data and format into $this->data and $this->dataformat.

This method should be called before self::set_user_data

Parameters
stdClass$field
Exceptions
coding_exception

◆ set_user_data()

profile_field_base::set_user_data (   $data,
  $dataformat 
)
inherited

Sets user id and user data for the field.

Parameters
mixed$data
int$dataformat

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