Docs For Class custom

Description

Custom Profile Fields

Located in /includes/functions_profile_fields.php (line 23)

Direct descendents

Class	Description
custom_profile_admin	Custom Profile Fields ACP

Variable Summary

mixed $options_lang

mixed $profile_cache

mixed $profile_types

Method Summary

void build_cache ()

void build_insert_sql_array ( $cp_data)

void generate_bool ( $profile_row, [ $preview = false])

void generate_date ( $profile_row, [ $preview = false])

void generate_dropdown ( $profile_row, [ $preview = false])

void generate_int ( $profile_row, [ $preview = false])

void generate_profile_fields ( $mode, $lang_id)

void generate_profile_fields_template ( $mode, [ $user_id = 0], [ $profile_row = false])

void generate_string ( $profile_row, [ $preview = false])

void generate_text ( $profile_row, [ $preview = false])

void get_option_lang ( $field_id, $lang_id, $field_type, $preview)

void get_profile_field ( $profile_row)

void get_profile_value ( $ident_ary)

void get_var ( $field_validation, &$profile_row, $default_value, $preview)

void process_field_row ( $mode, $profile_row)

void submit_cp_field ( $mode, $lang_id, &$cp_data, &$cp_error)

void validate_profile_field ( $field_type, &$field_value, $field_data)

Variables

mixed $options_lang = array() (line 27)

mixed $profile_cache = array() (line 26)

mixed $profile_types = array(FIELD_INT => 'int', FIELD_STRING => 'string', FIELD_TEXT => 'text', FIELD_BOOL => 'bool', FIELD_DROPDOWN => 'dropdown', FIELD_DATE => 'date') (line 25)

Methods

build_cache (line 203)

Build profile cache, used for display

access: private

void build_cache ()

build_insert_sql_array (line 801)

Build Array for user insertion into custom profile fields table

void build_insert_sql_array ( $cp_data)

$cp_data

generate_bool (line 684)

Process bool-type

access: private

void generate_bool ( $profile_row, [ $preview = false])

$profile_row
$preview

generate_date (line 625)

Process date-type

access: private

void generate_date ( $profile_row, [ $preview = false])

$profile_row
$preview

generate_dropdown (line 744)

Process dropdown-type

access: private

void generate_dropdown ( $profile_row, [ $preview = false])

$profile_row
$preview

generate_int (line 613)

Process int-type

access: private

void generate_int ( $profile_row, [ $preview = false])

$profile_row
$preview

generate_profile_fields (line 34)

Assign editable fields to template, mode can be profile (for profile change) or register (for registration)

Called by ucp_profile and ucp_register

access: public

void generate_profile_fields ( $mode, $lang_id)

$mode
$lang_id

generate_profile_fields_template (line 357)

Assign fields to template, used for viewprofile, viewtopic and memberlist (if load setting is enabled)

This is directly connected to the user -> mode == grab is to grab the user specific fields, mode == show is for assigning the row to the template

access: public

void generate_profile_fields_template ( $mode, [ $user_id = 0], [ $profile_row = false])

$mode
$user_id
$profile_row

generate_string (line 715)

Process string-type

access: private

void generate_string ( $profile_row, [ $preview = false])

$profile_row
$preview

generate_text (line 727)

Process text-type

access: private

void generate_text ( $profile_row, [ $preview = false])

$profile_row
$preview

get_option_lang (line 230)

Get language entries for options and store them here for later use

void get_option_lang ( $field_id, $lang_id, $field_type, $preview)

$field_id
$lang_id
$field_type
$preview

get_profile_field (line 837)

Get profile field value on submit

access: private

void get_profile_field ( $profile_row)

$profile_row

get_profile_value (line 449)

Get Profile Value for display

void get_profile_value ( $ident_ary)

$ident_ary

get_var (line 554)

Get field value for registration/profile

access: private

void get_var ( $field_validation, &$profile_row, $default_value, $preview)

$field_validation
&$profile_row
$default_value
$preview

process_field_row (line 773)

Return Templated value/field. Possible values for $mode are:

change == user is able to set/enter profile values; preview == just show the value

access: private

void process_field_row ( $mode, $profile_row)

$mode
$profile_row

submit_cp_field (line 265)

Submit profile field

access: public

void submit_cp_field ( $mode, $lang_id, &$cp_data, &$cp_error)

$mode
$lang_id
&$cp_data
&$cp_error

validate_profile_field (line 91)

Validate entered profile field data

access: public

void validate_profile_field ( $field_type, &$field_value, $field_data)

$field_type
&$field_value
$field_data

custom_profile