Class: WBzone

Changes: 1.2 -> 1.3: 14 jul 09 updated: file is PEAR compatible 1.1 -> 1.2: 02 jul 09 added: $this->sIDrowname, $this->aObjects 1.0 -> 1.1: 30 jun 09 added: getWBzone() function

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	1.3
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 = "wbZoneID"

[line 60]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBzone"

[line 43]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbZoneCode =

[line 54]

Variable that contains zone code

Tags:

access:

public

Type:

string

[ Top ]

$wbZoneID =

[line 49]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

Class Methods

method createWBzone [line 96]

object created createWBzone(
string
$this->wbZoneCode)

WBzone object creation function

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

<?php
$aVars = array("wbZoneCode" => "FooCode");
$oWBzone = new WBzone($aVars);
echo $oWBzone->createWBzone()->wbZoneID;
// zoneID
?>

Tags:

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

Parameters:

string

$this->wbZoneCode

code of the zone (required)

[ Top ]

method deleteWBzone [line 205]

bool deleteWBzone(
int
$this->wbZoneID)

WBzone object deletion function

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

<?php
$aVars = array("wbZoneID" => 12);
$oWBzone = new WBzone($aVars);
echo $oWBzone->deleteWBzone();
// 1
?>

Tags:

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

Parameters:

int

$this->wbZoneID

ID of the zone to be deleted (required)

[ Top ]

method getWBzone [line 246]

object WBreport getWBzone(
int
$this->wbZoneID)

WBzone object obtention function

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

<?php
$aVars = array("wbZoneID" => 12);
$oWBzone = new WBzone($aVars);
echo $oWBzone->getWBzone()->wbZoneName;
// fooName
?>

Tags:

return:	object
since:	Version 1.1
usedby:	WBsubZone::getWBsubZone()
uses:	WBobject::getUniqueFromDB()

Parameters:

int

$this->wbZoneID

ID of the zone to get (required)

[ Top ]

method updateWBzone [line 147]

object updated updateWBzone(
int
$this->wbZoneID, string
$this->wbZoneCode)

WBzone object update function

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

<?php
$aVars = array("wbZoneID" => 12, "wbZoneCode" => "fooCode");
$oWBzone = new WBzone($aVars);
echo $oWBzone->updateWBzone()->wbZoneID;
// 12
?>

Tags:

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

Parameters:

int	$this->wbZoneID	ID of the zone to be updated (required)
string	$this->wbZoneCode	code of the zone (required)

[ Top ]

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