type_string_common
abstract class type_string_common extends type_base
Properties
protected request | $request | Request object |
from type_base |
protected template | $template | Template object |
from type_base |
protected user | $user | User object |
from type_base |
protected | $validation_options |
Methods
Get Profile Value for display
Get the input for the supplied language options
Allows exclusion of options in single steps of the creation process
Allows exclusion of options in single steps of the creation process
Allows manipulating the intended variables if needed
Allows manipulating the intended variables if needed
Allows assigning of additional template variables
Return templated value/field. Possible values for $mode are: change == user is able to set/enter profile values; preview == just show the value
Return possible validation options
Get default value for this type
Validate entered profile field data
Get Profile Value for display
Get Profile Value ID for display (the raw, unprocessed user data)
Details
in
type_base at line 53
string
get_name()
Get the translated name of the type
in
type_base at line 61
string
get_service_name()
Get the name of service representing the type
in
type_base at line 69
string
get_template_filename()
Get the name of template file for this type
in
type_base at line 77
string
get_field_ident(array $field_data)
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.
in
type_base at line 85
string
get_field_name(string $field_name)
Get the localized name of the field
at line 133
mixed
get_profile_contact_value(mixed $field_value, array $field_data)
Get Profile Value for display
When displaying a contact field, we don't want to have links already parsed and more
in
type_base at line 101
array
get_language_options_input(array $field_data)
Get the input for the supplied language options
at line 141
mixed
prepare_options_form(array $exclude_options, array $visibility_options)
Allows exclusion of options in single steps of the creation process
in
type_base at line 122
array
validate_options_on_submit(array $error, array $field_data)
Allows exclusion of options in single steps of the creation process
in
type_base at line 130
mixed
get_excluded_options(string $key, string $action, mixed $current_value, array $field_data, int $step)
Allows manipulating the intended variables if needed
in
type_base at line 148
mixed
prepare_hidden_fields(int $step, string $key, string $action, array $field_data)
Allows manipulating the intended variables if needed
in
type_base at line 180
null
display_options(array $template_vars, array $field_data)
Allows assigning of additional template variables
in
type_base at line 189
null
process_field_row(string $mode, array $profile_row)
Return templated value/field. Possible values for $mode are: change == user is able to set/enter profile values; preview == just show the value
at line 36
validate_options($field_data)
Return possible validation options
at line 51
mixed
get_default_field_value(array $field_data)
Get default value for this type
at line 64
mixed
validate_string_profile_field(string $field_type, mixed $field_value, array $field_data)
Validate entered profile field data
at line 104
mixed
get_profile_value(mixed $field_value, array $field_data)
Get Profile Value for display
at line 120
mixed
get_profile_value_raw(mixed $field_value, array $field_data)
Get Profile Value ID for display (the raw, unprocessed user data)