Docs For Class Userfield

Class Overview

Userfield Class

Located in /blogs/inc/users/model/_userfield.class.php [line 41]

DataObject
   |
   --Userfield

Author(s):

Information Tags:

Version:

beta

Properties

$name
$type

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$allow_ID_insert DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::action_icon() Generate requested action icon depending on perm DataObject::action_link() Generate requested action link depending on perm DataObject::check_delete() Check relations for restrictions before deleting DataObject::check_relations() Check relations for restrictions or cascades. DataObject::confirm_delete() Displays form to confirm deletion of this object DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() Delete object from DB. DataObject::dbexists() Check existence of specified value in unique field. DataObject::dbinsert() Insert object into DB based on previously recorded changes. DataObject::dbsave() Inserts or Updates depending on object state. DataObject::dbupdate() Update the DB based on previously recorded changes DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::get_action_title() Generate help title text for action DataObject::history_info_icon() Create icon with dataobject history DataObject::ID() Template function: Displays object ID. DataObject::set() Set param value DataObject::set_from_Request() Set a parameter from a Request form value. DataObject::set_param() Set param value. DataObject::set_string_from_param() Set a string parameter from a Request form value.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$allow_ID_insert

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::action_icon()

Generate requested action icon depending on perm

DataObject::action_link()

Generate requested action link depending on perm

DataObject::check_delete()

Check relations for restrictions before deleting

DataObject::check_relations()

Check relations for restrictions or cascades.

DataObject::confirm_delete()

Displays form to confirm deletion of this object

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

Delete object from DB.

DataObject::dbexists()

Check existence of specified value in unique field.

DataObject::dbinsert()

Insert object into DB based on previously recorded changes.

DataObject::dbsave()

Inserts or Updates depending on object state.

DataObject::dbupdate()

Update the DB based on previously recorded changes

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::get_action_title()

Generate help title text for action

DataObject::history_info_icon()

Create icon with dataobject history

DataObject::ID()

Template function: Displays object ID.

DataObject::set()

Set param value

DataObject::set_from_Request()

Set a parameter from a Request form value.

DataObject::set_param()

Set param value.

DataObject::set_string_from_param()

Set a string parameter from a Request form value.

[ Top ]

Property Summary

mixed	$name
mixed	$type

[ Top ]

Method Summary

Userfield	Userfield()	Constructor
int	dbexists()	Check existence of specified user field ID in ufdf_ID unique field.
string	get_name()	Get user field name.
array	get_types()	Returns array of possible user field types
boolean	load_from_Request()	Load data from Request form fields.
void	set()	Set param value

[ Top ]

Properties

mixed $name = '' [line 44]

[ Top ]

mixed $type = '' [line 43]

[ Top ]

Methods

Constructor Userfield [line 51]

Userfield Userfield(
[object Database
$db_row = NULL] 
)

Constructor

Parameters:

object Database

$db_row:

row

[ Top ]

dbexists [line 156]

int dbexists(
)

Check existence of specified user field ID in ufdf_ID unique field.

API Tags:

Return:

ID if user field exists otherwise NULL/false

Information Tags:

Todo:

dh> Two returns here!!

Redefinition of:

DataObject::dbexists(): Check existence of specified value in unique field.

[ Top ]

get_name [line 144]

string get_name(
)

Get user field name.

API Tags:

Return:

user field name

[ Top ]

get_types [line 80]

array get_types(
)

Returns array of possible user field types

[ Top ]

load_from_Request [line 98]

boolean load_from_Request(
)

Load data from Request form fields.

API Tags:

Return:

true if loaded data seems valid.

[ Top ]

set [line 127]

void set(
string
$parname, mixed
$parvalue 
)

Set param value

By default, all values will be considered strings

Parameters:

string	$parname:	parameter name
mixed	$parvalue:	parameter value

Redefinition of:

DataObject::set(): Set param value

[ Top ]

Multilingual multiuser multiblog engine

Class: Userfield

Class Userfield

Packages

Classes

Files