| [ Index ] |
PHP Cross Reference of phpBB-3.3.14-deutsch |
[Source view] [Print] [Project Stats]
This file is part of the phpBB Forum Software package.
| Copyright: | (c) phpBB Limited |
| License: | GNU General Public License, version 2 (GPL-2.0) |
| File Size: | 226 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
type_interface:: (24 methods):
get_name()
get_name_short()
get_service_name()
get_template_filename()
get_options()
get_default_option_values()
get_default_field_value()
get_profile_field()
validate_profile_field()
get_profile_value()
get_profile_value_raw()
get_profile_contact_value()
generate_field()
get_field_ident()
get_field_name()
get_database_column_type()
get_language_options()
get_language_options_input()
prepare_options_form()
validate_options_on_submit()
get_excluded_options()
prepare_hidden_fields()
display_options()
process_field_row()
Interface: type_interface - X-Ref
| get_name() X-Ref |
| Get the translated name of the type return: string Translated name of the field type |
| get_name_short() X-Ref |
| Get the short name of the type, used for error messages and template loops return: string lowercase version of the fields type |
| get_service_name() X-Ref |
| Get the name of service representing the type return: string lowercase version of the fields type |
| get_template_filename() X-Ref |
| Get the name of template file for this type return: string Returns the name of the template file |
| get_options($default_lang_id, $field_data) X-Ref |
| Get dropdown options for second step in ACP param: string $default_lang_id ID of the default language param: array $field_data Array with data for this field return: array with the acp options |
| get_default_option_values() X-Ref |
| Get default values for the options of this type return: array with values like default field size and more |
| get_default_field_value($field_data) X-Ref |
| Get default value for this type param: array $field_data Array with data for this field return: mixed default value for new users when no value is given |
| get_profile_field($profile_row) X-Ref |
| Get profile field value on submit param: array $profile_row Array with data for this field return: mixed Submitted value of the profile field |
| validate_profile_field(&$field_value, $field_data) X-Ref |
| Validate entered profile field data param: mixed $field_value Field value to validate param: array $field_data Array with requirements of the field return: mixed String with the error message |
| get_profile_value($field_value, $field_data) X-Ref |
| Get Profile Value for display param: mixed $field_value Field value as stored in the database param: array $field_data Array with requirements of the field return: mixed Field value to display |
| get_profile_value_raw($field_value, $field_data) X-Ref |
| Get Profile Value ID for display (the raw, unprocessed user data) param: mixed $field_value Field value as stored in the database param: array $field_data Array with requirements of the field return: mixed Field value ID to display |
| get_profile_contact_value($field_value, $field_data) X-Ref |
| Get Profile Value for display When displaying a contact field, we don't want to have links already parsed and more param: mixed $field_value Field value as stored in the database param: array $field_data Array with requirements of the field return: mixed Field value to display |
| generate_field($profile_row, $preview_options = false) X-Ref |
| Generate the input field for display param: array $profile_row Array with data for this field param: mixed $preview_options When previewing we use different data return: null |
| get_field_ident($field_data) X-Ref |
| Get the ident of the field Some types are multivalue, we can't give them a field_id as we would not know which to pick. param: array $field_data Array with data for this field return: string ident of the field |
| get_field_name($field_name) X-Ref |
| Get the localized name of the field param: string $field_name Unlocalized name of this field return: string Localized name of the field |
| get_database_column_type() X-Ref |
| Get the column type for the database return: string Returns the database column type |
| get_language_options($field_data) X-Ref |
| Get the options we need to display for the language input fields in the ACP param: array $field_data Array with data for this field return: array Returns the language options we need to generate |
| get_language_options_input($field_data) X-Ref |
| Get the input for the supplied language options param: array $field_data Array with data for this field return: array Returns the language options we need to generate |
| prepare_options_form(&$exclude_options, &$visibility_options) X-Ref |
| Allows exclusion of options in single steps of the creation process param: array $exclude_options Array with options that should be excluded in the steps param: array $visibility_options Array with options responsible for the fields visibility return: mixed Returns the provided language options |
| validate_options_on_submit($error, $field_data) X-Ref |
| Allows exclusion of options in single steps of the creation process param: array $error Array with error messages param: array $field_data Array with data for this field return: array Array with error messages |
| get_excluded_options($key, $action, $current_value, &$field_data, $step) X-Ref |
| Allows manipulating the intended variables if needed param: string $key Name of the option param: string $action Currently performed action (create|edit) param: mixed $current_value Currently value of the option param: array $field_data Array with data for this field param: int $step Step on which the option is excluded return: mixed Final value of the option |
| prepare_hidden_fields($step, $key, $action, &$field_data) X-Ref |
| Allows manipulating the intended variables if needed param: int $step Step on which the option is hidden param: string $key Name of the option param: string $action Currently performed action (create|edit) param: array $field_data Array with data for this field return: mixed Final value of the option |
| display_options(&$template_vars, &$field_data) X-Ref |
| Allows assigning of additional template variables param: array $template_vars Template variables we are going to assign param: array $field_data Array with data for this field return: null |
| process_field_row($mode, $profile_row) X-Ref |
| Return templated value/field. Possible values for $mode are: change == user is able to set/enter profile values; preview == just show the value param: string $mode Mode for displaying the field (preview|change) param: array $profile_row Array with data for this field return: null |
| Generated: Mon Nov 25 19:05:08 2024 | Cross-referenced by PHPXref 0.7.1 |