Class: WBmarket

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	1.2
usedby:	SPsetup::updateSPcycle()
usedby:	SPsetup::createSPsetup()
license:	GNU Public License

[ Top ]

Class Variables

$aObjects = array()

[line 65]

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 = "wbMarketID"

[line 60]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBmarket"

[line 43]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbMarketID =

[line 49]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$wbMarketName =

[line 54]

Variable that contains name of the market

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createWBmarket [line 96]

object created createWBmarket(
string
$this->wbMarketName)

WBmarket object creation function

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

<?php
$aVars = array("wbMarketName" => "fooName");
$oWBmarket = new WBmarket($aVars);
echo $oWBmarket->createWBmarket()->wbMarketID;
// marketID
?>

Tags:

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

Parameters:

string

$this->wbMarketName

name of the market (required)

[ Top ]

method deleteWBmarket [line 206]

bool deleteWBmarket(
int
$this->wbMarketID)

WBmarket object deletion function

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

<?php
$aVars = array("wbMarketID" => 12);
$oWBmarket = new WBmarket($aVars);
echo $oWBmarket->deleteWBmarket();
// 1
?>

Tags:

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

Parameters:

int

$this->wbMarketID

ID of the market to be deleted (required)

[ Top ]

method getWBmarket [line 247]

object WBmarket getWBmarket(
int
$this->wbMarketID)

WBmarket object obtention function

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

<?php
$aVars = array("wbMarketID" => 12);
$oWBmarket = new WBmarket($aVars);
echo $oWBmarket->getWBmarket()->wbMarketName;
// fooName
?>

Tags:

return:	object
since:	Version 1.0
usedby:	SPsetup::getSPsetup()
usedby:	Link_WBprofiledUser_WBmarket::getLink_WBprofiledUser_WBmarket()
usedby:	Link_WBmarket_WBcountry::getLink_WBmarket_WBcountry()
uses:	WBobject::getUniqueFromDB()

Parameters:

int

$this->wbMarketID

ID of the market to get (required)

[ Top ]

method updateWBmarket [line 147]

object updated updateWBmarket(
int
$this->wbMarketID, string
$this->wbMarketName)

WBmarket object update function

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

<?php
$aVars = array("wbMarketID" => 12, "wbMarketName" => "fooName");
$oWBmarket = new WBmarket($aVars);
echo $oWBmarket->updateWBmarket()->wbProfileID;
// 12
?>

Tags:

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

Parameters:

int	$this->wbMarketID	ID of the market to be updated (required)
string	$this->wbMarketName	name of the market (required)

[ Top ]

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