Class: WBprofile

Changes: 1.2 -> 1.3: 14 aug 09 updated: updateWBprofile() function bug solved 1.1 -> 1.2: 15 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.3
license:	GNU Public License

[ Top ]

Class Variables

$aObjects = array(
"wbProfileApplication" => "WBapplication"
)

[line 86]

Variable that contains objects list

Tags:

access:

protected

Type:

array

[ Top ]

$database = "prysma"

[line 39]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$sIDrowname = "wbProfileID"

[line 81]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBprofile"

[line 44]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbProfileApplication =

[line 55]

Variable that contains profile application object

Tags:

access:

public

Type:

object

[ Top ]

$wbProfileApplicationID =

[line 60]

Variable that contains profile application ID

Tags:

access:

public

Type:

object

[ Top ]

$wbProfileCode =

[line 65]

Variable that contains code of the profile

Tags:

access:

public

Type:

string

[ Top ]

$wbProfileDescription =

[line 75]

Variable that contains profile description

Tags:

access:

public

Type:

string

[ Top ]

$wbProfileID =

[line 50]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$wbProfileName =

[line 70]

Variable that contains profile name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createWBprofile [line 130]

object created createWBprofile(
object
$this->wbProfileApplication, string
$this->wbProfileCode, string
$this->wbProfileName, string
$this->wbProfileDescription)

WBprofile object creation function

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

<?php
$aVars = array(
"wbProfileApplication" => $oWBapplication,
"wbProfileCode" => "fooCode",
"wbProfileName" => "barName",
"wbProfileDescription" => "fooDescription"
);
$oWBprofile = new WBprofile($aVars);
echo $oWBprofile->createWBprofile()->wbProfileID;
// profileID
?>

Tags:

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

Parameters:

object	$this->wbProfileApplication	WBapplication that has created the log (required)
string	$this->wbProfileCode	code of the profile (required)
string	$this->wbProfileName	name of the profile (required)
string	$this->wbProfileDescription	description of the profile

[ Top ]

method deleteWBprofile [line 307]

bool deleteWBprofile(
int
$this->wbProfileID)

WBprofile object deletion function

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

<?php
$aVars = array("wbProfileID" => 12);
$oWBprofile = new WBprofile($aVars);
echo $oWBprofile->deleteWBprofile();
// 1
?>

Tags:

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

Parameters:

int

$this->wbProfileID

ID of the profile to be deleted (required)

[ Top ]

method getWBprofile [line 350]

object WBprofile getWBprofile(
int
$this->wbProfileID)

WBprofile object obtention function

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

<?php
$aVars = array("wbProfileID" => 12);
$oWBprofile = new WBprofile($aVars);
echo $oWBprofile->getWBprofile()->wbProfileName;
// fooName
?>

Tags:

return:	object
since:	Version 1.1
usedby:	WBprofiledUser::getWBprofiledUser()
usedby:	WBactivityLog::getWBactivityLog()
uses:	WBobject::getUniqueFromDB()
uses:	WBapplication::getWBapplication()

Parameters:

int

$this->wbProfileID

ID of the profile to get (required)

[ Top ]

method updateWBprofile [line 215]

object updated updateWBprofile(
int
$this->wbProfileID, string
$this->wbProfileApplication, string
$this->wbProfileCode, string
$this->wbProfileName, string
$this->wbProfileDescription)

WBprofile object update function

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

<?php
$aVars = array("wbProfileID"=>12,"wbProfileApplication"=>$oWBapplication,"wbProfileCode"=>"barCode","wbProfileName"=>"fooName",
"wbProfileDescription"=>"barDescription");
$oWBprofile = new WBprofile($aVars);
echo $oWBprofile->updateWBprofile()->wbProfileID;
// 12
?>

Tags:

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

Parameters:

int	$this->wbProfileID	ID of the profile to be updated (required)
string	$this->wbProfileApplication	application of the profile (required)
string	$this->wbProfileCode	code of the profile (required)
string	$this->wbProfileName	name of the profile (required)
string	$this->wbProfileDescription	description of the profile (required)

[ Top ]

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

Class: WBprofile

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Methods

Class: WBobject

Class Details

Tags:

Class Variables

$aObjects = array( "wbProfileApplication" => "WBapplication" )

Tags:

$database = "prysma"

Tags:

$sIDrowname = "wbProfileID"

Tags:

$table = "WBprofile"

Tags:

$wbProfileApplication =

Tags:

$wbProfileApplicationID =

Tags:

$wbProfileCode =

Tags:

$wbProfileDescription =

Tags:

$wbProfileID =

Tags:

$wbProfileName =

Tags:

Class Methods

method createWBprofile [line 130]

Tags:

Parameters:

method deleteWBprofile [line 307]

Tags:

Parameters:

method getWBprofile [line 350]

Tags:

Parameters:

method updateWBprofile [line 215]

Tags:

Parameters:

$aObjects = array(
"wbProfileApplication" => "WBapplication"
)