eZUserSetting Class Reference

Inheritance diagram for eZUserSetting:

Collaboration diagram for eZUserSetting:

List of all members.

Public Member Functions
	eZUserSetting ($row)
	setAttribute ($attr, $val)
Static Public Member Functions
static	create ($userID, $isEnabled)
static	definition ()
static	fetch ($userID, $asObject=true)
static	fetchAll ($asObject=true)
static	removeByUserID ($userID)
Public Attributes
	$IsEnabled
	$MaxLogin
	$UserID

---

Detailed Description

Definition at line 36 of file ezusersetting.php.

---

Member Function Documentation

static eZUserSetting::create	(	$	userID,
		$	isEnabled
	)		[static]

Definition at line 68 of file ezusersetting.php.

static eZUserSetting::definition

(

)

[static]

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 43 of file ezusersetting.php.

Referenced by fetch(), fetchAll(), and removeByUserID().

eZUserSetting::eZUserSetting

(

$

row

)

Definition at line 38 of file ezusersetting.php.

Referenced by create().

static eZUserSetting::fetch	(	$	userID,
		$	asObject = true
	)		[static]

Fetch message object with $userID

Definition at line 100 of file ezusersetting.php.

Referenced by eZUserType\fromString(), and setAttribute().

static eZUserSetting::fetchAll

(

$

asObject = true

)

[static]

Fetch all settings from database

Definition at line 111 of file ezusersetting.php.

static eZUserSetting::removeByUserID

(

$

userID

)

[static]

Definition at line 121 of file ezusersetting.php.

Referenced by eZUser\removeUser().

eZUserSetting::setAttribute	(	$	attr,
		$	val
	)

Sets the attribute $attr to the value $val. The attribute must be present in the objects definition fields or set functions.

Reimplemented from eZPersistentObject.

Definition at line 77 of file ezusersetting.php.

---

Member Data Documentation

eZUserSetting::$IsEnabled

Definition at line 129 of file ezusersetting.php.

eZUserSetting::$MaxLogin

Definition at line 130 of file ezusersetting.php.

eZUserSetting::$UserID

Definition at line 128 of file ezusersetting.php.

---

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

• ezusersetting.php