Class ProfileField

`extends`	`XoopsObject`

XoopsObject
- ProfileField

Located at modules\profile\class\field.php

Methods


					
	public

__construct()

constructor

normally, this is called from child classes only

Overrides

XoopsObject::__construct()


					
	public

setVar(string $key, mixed $value, bool $not_gpc = false)

Extra treatment dealing with non latin encoding Tricky solution

Parameters

`$key`	name of the variable to assign
`$value`	value to assign

Overrides

XoopsObject::setVar()


					
	public

getVar(string $key, string $format = 's'): mixed

returns a specific variable for the object in a proper format

YOU SHOULD NOT USE ANY OF THE UNICODE TYPES, THEY WILL BE REMOVED

Parameters

`$key`	key of the object's variable to be returned
`$format`	format to use for the output

Returns

formatted value of the variable

Overrides

XoopsObject::getVar()


					
	public

getEditElement(XoopsUser $user, ProfileProfile $profile): XoopsFormElement

Returns a {@link XoopsFormElement} for editing the value of this field

Parameters

`$user`	{@link XoopsUser} object to edit the value of
`$profile`	{@link ProfileProfile} object to edit the value of


					
	public

getOutputValue(XoopsUser &$user, ProfileProfile $profile): mixed

Returns a value for output of this field

Parameters

`$user`	{@link XoopsUser} object to get the value of
`$profile`	object to get the value of


					
	public

getValueForSave(mixed $value): mixed

Returns a value ready to be saved in the database

Parameters

$value

Value to format


					
	public

getUserVars(): array

Get names of user variables

Methods inherited from XoopsObject
`XoopsObject(), setNew(), unsetNew(), isNew(), setDirty(), unsetDirty(), isDirty(), initVar(), assignVar(), assignVars(), setVars(), destroyVars(), destoryVars(), setFormVars(), getVars(), getValues(), cleanVars(), registerFilter(), _loadFilters(), loadFilters(), xoopsClone(), __clone(), getErrors(), getHtmlErrors(), toArray()`

Properties
`public`	`$field_id`	#
`public`	`$cat_id`	#
`public`	`$field_type`	#
`public`	`$field_valuetype`	#
`public`	`$field_name`	#
`public`	`$field_title`	#
`public`	`$field_description`	#
`public`	`$field_required`	#
`public`	`$field_maxlength`	#
`public`	`$field_weight`	#
`public`	`$field_default`	#
`public`	`$field_notnull`	#
`public`	`$field_edit`	#
`public`	`$field_show`	#
`public`	`$field_config`	#
`public`	`$field_options`	#
`public`	`$step_id`	#

Properties inherited from XoopsObject
`$vars, $cleanVars, $_isNew, $_isDirty, $_errors, $_filters`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class ProfileField

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Parameters

Parameters