Class profile_define_checkbox.
More...
|
| define_after_data (&$mform) |
| Alter form based on submitted or existing data.
|
|
| define_editors () |
| Provides a method by which we can allow the default data in profile_define_* to use an editor.
|
|
| define_form (&$form) |
| Prints out the form snippet for creating or editing a profile field.
|
|
| define_form_common (&$form) |
| Prints out the form snippet for the part of creating or editing a profile field common to all data types.
|
|
| define_form_specific ($form) |
| Add elements for creating/editing a checkbox profile field.
|
|
| define_save ($data) |
| Add a new profile field or save changes to current field.
|
|
| define_save_preprocess ($data) |
| Preprocess data from the add/edit profile field form before it is saved.
|
|
| define_validate ($data, $files) |
| Validate the data from the add/edit profile field form.
|
|
| define_validate_common ($data, $files) |
| Validate the data from the add/edit profile field form that is common to all data types.
|
|
| define_validate_specific ($data, $files) |
| Validate the data from the add/edit profile field form that is specific to the current data type.
|
|
Class profile_define_checkbox.
- Copyright
- 2008 onwards Shane Elliot
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ define_after_data()
profile_define_base::define_after_data |
( |
& | $mform | ) |
|
|
inherited |
◆ define_editors()
profile_define_base::define_editors |
( |
| ) |
|
|
inherited |
Provides a method by which we can allow the default data in profile_define_* to use an editor.
This should return an array of editor names (which will need to be formatted/cleaned)
- Return values
-
Reimplemented in profile_define_textarea.
◆ define_form()
profile_define_base::define_form |
( |
& | $form | ) |
|
|
inherited |
Prints out the form snippet for creating or editing a profile field.
- Parameters
-
◆ define_form_common()
profile_define_base::define_form_common |
( |
& | $form | ) |
|
|
inherited |
Prints out the form snippet for the part of creating or editing a profile field common to all data types.
- Parameters
-
Reimplemented in profile_define_social.
◆ define_form_specific()
profile_define_checkbox::define_form_specific |
( |
| $form | ) |
|
Add elements for creating/editing a checkbox profile field.
- Parameters
-
Reimplemented from profile_define_base.
◆ define_save()
profile_define_base::define_save |
( |
| $data | ) |
|
|
inherited |
Add a new profile field or save changes to current field.
- Parameters
-
array | stdClass | $data | from the add/edit profile field form |
◆ define_save_preprocess()
profile_define_base::define_save_preprocess |
( |
| $data | ) |
|
|
inherited |
Preprocess data from the add/edit profile field form before it is saved.
This method is a hook for the child classes to overwrite.
- Parameters
-
array | stdClass | $data | from the add/edit profile field form |
- Return values
-
array|stdClass | processed data object |
Reimplemented in profile_define_datetime, profile_define_menu, and profile_define_social.
◆ define_validate()
profile_define_base::define_validate |
( |
| $data, |
|
|
| $files ) |
|
inherited |
Validate the data from the add/edit profile field form.
Generally this method should not be overwritten by child classes.
- Parameters
-
stdClass | array | $data | from the add/edit profile field form |
array | $files | |
- Return values
-
array | associative array of error messages |
◆ define_validate_common()
profile_define_base::define_validate_common |
( |
| $data, |
|
|
| $files ) |
|
inherited |
Validate the data from the add/edit profile field form that is common to all data types.
Generally this method should not be overwritten by child classes.
- Parameters
-
stdClass | array | $data | from the add/edit profile field form |
array | $files | |
- Return values
-
array | associative array of error messages |
Reimplemented in profile_define_social.
◆ define_validate_specific()
profile_define_base::define_validate_specific |
( |
| $data, |
|
|
| $files ) |
|
inherited |
Validate the data from the add/edit profile field form that is specific to the current data type.
- Parameters
-
- Return values
-
array | associative array of error messages |
Reimplemented in profile_define_datetime, and profile_define_menu.
The documentation for this class was generated from the following file:
- user/profile/field/checkbox/define.class.php