ProfileField Class Reference

Inheritance diagram for ProfileField:

Collaboration diagram for ProfileField:

Public Member Functions
	__construct ()
	setVar ($key, $value, $not_gpc=false)
	getVar ($key, $format='s')
	getEditElement ($user, $profile)
	getOutputValue (&$user, $profile)
	getValueForSave ($value)
	getUserVars ()
Public Member Functions inherited from XoopsObject
	__construct ()
	XoopsObject ()
	setNew ()
	unsetNew ()
	isNew ()
	setDirty ()
	unsetDirty ()
	isDirty ()
	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
	assignVar ($key, $value)
	assignVars ($var_arr)
	setVar ($key, $value, $not_gpc=false)
	setVars ($var_arr, $not_gpc=false)
	destroyVars ($var)
	destoryVars ($var)
	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
&	getVars ()
	getValues ($keys=null, $format='s', $maxDepth=1)
	getVar ($key, $format=null)
	cleanVars ()
	registerFilter ($filtername)
	_loadFilters ()
	loadFilters ($method)
	xoopsClone ()
	__clone ()
	setErrors ($err_str)
	getErrors ()
	getHtmlErrors ()
	toArray ()

Additional Inherited Members
Data Fields inherited from XoopsObject
	$vars = array()
	$cleanVars = array()
	$_isNew = false
	$_isDirty = false
	$_errors = array()
	$_filters = array()

Constructor & Destructor Documentation

__construct()

__construct

(

)

constructor

normally, this is called from child classes only

@access public

Reimplemented from XoopsObject.

Here is the call graph for this function:

Member Function Documentation

getEditElement()

getEditElement	(		$user,
			$profile
	)

Returns a XoopsFormElement for editing the value of this field

Parameters

XoopsUser	$user	XoopsUser object to edit the value of
ProfileProfile	$profile	ProfileProfile object to edit the value of

Returns

XoopsFormElement

Here is the call graph for this function:

getOutputValue()

getOutputValue	(	&	$user,
			$profile
	)

Returns a value for output of this field

Parameters

XoopsUser	$user	XoopsUser object to get the value of
profileProfile	$profile	object to get the value of

Returns

mixed

Here is the call graph for this function:

Here is the caller graph for this function:

getUserVars()

getUserVars

(

)

Get names of user variables

Returns

array

Here is the call graph for this function:

Here is the caller graph for this function:

getValueForSave()

getValueForSave

(

$value

)

Returns a value ready to be saved in the database

Parameters

mixed

$value

Value to format

Returns

mixed

Here is the call graph for this function:

getVar()

getVar	(		$key,
			$format = 's'
	)

Parameters

string	$key
string	$format

Returns

mixed

Reimplemented from XoopsObject.

Here is the caller graph for this function:

setVar()

setVar	(		$key,
			$value,
			$not_gpc = false
	)

Extra treatment dealing with non latin encoding Tricky solution

Parameters

string	$key
mixed	$value
bool	$not_gpc

Reimplemented from XoopsObject.

---

The documentation for this class was generated from the following file:

• C:/xoops2511b2/htdocs/modules/profile/class/field.php