Class: WBprofiledUserSetting

Source Location: /WBprofiledUserSetting.php

Class Overview

WBobject
   |
   --WBprofiledUserSetting

This class manages WBprofiledUserSetting objects. Settings that are specific to a User logged with a specific profile.

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Inherited Methods

Class: WBobject

WBobject::__construct(): Construction function
WBobject::addToDB(): Rows insertion to database function
WBobject::deleteFromDB(): Rows deletion function
WBobject::getIDrowname(): ID rowname obtention function
WBobject::getObjects(): Objects list obtention function
WBobject::getUniqueFromDB(): Unique Row obtention function
WBobject::objectToArray(): Object to array transformation function
WBobject::updateDB(): Rows update function

Class Details

[line 32]
This class manages WBprofiledUserSetting objects. Settings that are specific to a User logged with a specific profile.

Created on 30 jun 09

Changes: 1.1 -> 1.2: 14 jul 09 updated: file is PEAR compatible 1.0 -> 1.1: 02 jul 09 added: $this->sIDrowname, $this->aObjects

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	1.2
license:	GNU Public License

[ Top ]

Class Variables

$aObjects = array(
"wbProfiledUserSettingUser" => "WBuser")

[line 80]

Variable that contains objects list

Tags:

access:

protected

Type:

array

[ Top ]

$database = "prysma"

[line 38]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$sIDrowname = "wbProfiledUserSettingID"

[line 75]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBprofiledUserSetting"

[line 43]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbProfiledUserSettingCode =

[line 54]

Variable that contains code of settings

Tags:

access:

public

Type:

string

[ Top ]

$wbProfiledUserSettingID =

[line 49]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$wbProfiledUserSettingUser =

[line 64]

Variable that contains user object

Tags:

access:

public

Type:

object

[ Top ]

$wbProfiledUserSettingUserID =

[line 69]

Variable that contains user ID

Tags:

access:

public

Type:

int

[ Top ]

$wbProfiledUserSettingValue =

[line 59]

Variable that contains value

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createWBprofiledUserSetting [line 122]

object created createWBprofiledUserSetting(
string
$this->wbProfiledUserSettingCode, string
$this->wbProfiledUserSettingValue, object
$this->wbProfiledUserSettingUser)

WBprofiledUserSetting object creation function

This function is used to create a WBprofiledUserSetting object Result is stored in $this and object is returned

<?php
$aVars = array(
"wbProfiledUserSettingCode" => "fooCode",
"wbProfiledUserSettingValue" => "barValue",
"wbProfiledUserSettingUser" => $oWBuser
);
$oWBprofiledUserSetting = new WBprofiledUserSetting($aVars);
$tempvalue $oWBprofiledUserSetting->createWBprofiledUserSetting();
echo $tempvalue->wbProfiledUserSettingID;
// profiledusersettingsID
?>

Tags:

return:	object or false
since:	Version 1.0
uses:	WBobject::addToDB()

Parameters:

string	$this->wbProfiledUserSettingCode	code of the setting (required)
string	$this->wbProfiledUserSettingValue	value of the setting (required)
object	$this->wbProfiledUserSettingUser	user object of the setting (required)

[ Top ]

method deleteWBprofiledUserSetting [line 300]

bool deleteWBprofiledUserSetting(
int
$this->wbProfiledUserSettingID)

WBprofiledUserSetting object deletion function

This function is used to delete a WBprofiledUserSetting by its ID Result is returned

<?php
$aVars = array("wbProfiledUserSettingID" => 12);
$oWBprofiledUserSetting = new WBprofiledUserSetting($aVars);
echo $oWBprofiledUserSetting->deleteWBprofiledUserSetting();
// 1
?>

Tags:

return:	true or false weither the object could be deleted or not
since:	Version 1.0
uses:	WBobject::deleteFromDB()

Parameters:

int

$this->wbProfiledUserSettingID

ID of the setting to be deleted (required)

[ Top ]

method getWBprofiledUserSetting [line 344]

object WBprofiledUserSetting getWBprofiledUserSetting(
int
$this->wbProfiledUserSettingID)

WBprofiledUserSetting object obtention function

This function is used to get a WBprofiledUserSetting by its ID Result is returned

<?php
$aVars = array("wbProfiledUserSettingID" => 12);
$oWBprofiledUserSetting = new WBprofiledUserSetting($aVars);
$tempvalue = $oWBprofiledUserSetting->getWBprofiledUserSetting();
echo $tempvalue->wbProfiledUserSettingCode;
// fooCode
?>

Tags:

return:	object
since:	Version 1.0
uses:	WBuser::getWBuser()
uses:	WBobject::getUniqueFromDB()

Parameters:

int

$this->wbProfiledUserSettingID

ID of the setting to get (required)

[ Top ]

method updateWBprofiledUserSetting [line 212]

object updated updateWBprofiledUserSetting(
int
$this->wbProfiledUserSettingID, string
$this->wbProfiledUserSettingCode, string
$this->wbProfiledUserSettingValue, object
$this->wbProfiledUserSettingUser)

WBprofiledUserSetting object update function

This function is used to update a WBprofiledUserSetting Result is stored in $this and object is returned

<?php
$aVars = array(
"wbProfiledUserSettingID" => 12,
"wbProfiledUserSettingCode" => "fooCode",
"wbProfiledUserSettingValue" => "barValue",
"wbProfiledUserSettingUser" => $oWBuser
);
$oWBprofiledUserSetting = new WBprofiledUserSetting($aVars);
$tempvalue = $oWBprofiledUserSetting->updateWBprofiledUserSetting();
echo $tempvalue->wbProfiledUserSettingID;
// 12
?>

Tags:

return:	object or false
since:	Version 1.0
uses:	WBobject::updateDB()

Parameters:

int	$this->wbProfiledUserSettingID	ID of the setting to be updated (required)
string	$this->wbProfiledUserSettingCode	code of the setting (required)
string	$this->wbProfiledUserSettingValue	value of the setting (required)
object	$this->wbProfiledUserSettingUser	user for the setting (required)

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:31:10 +0200 by phpDocumentor 1.4.1

Class: WBprofiledUserSetting

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Methods

Class: WBobject

Class Details

Tags:

Class Variables

$aObjects = array( "wbProfiledUserSettingUser" => "WBuser")

Tags:

$database = "prysma"

Tags:

$sIDrowname = "wbProfiledUserSettingID"

Tags:

$table = "WBprofiledUserSetting"

Tags:

$wbProfiledUserSettingCode =

Tags:

$wbProfiledUserSettingID =

Tags:

$wbProfiledUserSettingUser =

Tags:

$wbProfiledUserSettingUserID =

Tags:

$wbProfiledUserSettingValue =

Tags:

Class Methods

method createWBprofiledUserSetting [line 122]

Tags:

Parameters:

method deleteWBprofiledUserSetting [line 300]

Tags:

Parameters:

method getWBprofiledUserSetting [line 344]

Tags:

Parameters:

method updateWBprofiledUserSetting [line 212]

Tags:

Parameters:

$aObjects = array(
"wbProfiledUserSettingUser" => "WBuser")