Class: TSbucketSet

Source Location: /TSbucketSet.php

Class Overview

WBobject
   |
   --TSbucketSet

This class manages TSbucketSet objects. Series of information linked to a specific horizon.

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 31]
This class manages TSbucketSet objects. Series of information linked to a specific horizon.

Created on 08 jul 09

Changes: 1.0 -> 1.1: 10 jul 09 updated: file is PEAR compatible

Tags:

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

[ Top ]

Class Variables

$aObjects = array("tsBucketSetHorizon" => "TShorizon")

[line 69]

Variable that contains objects list

Tags:

access:

protected

Type:

array

[ Top ]

$database = "prysma"

[line 37]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$sIDrowname = "tsBucketSetID"

[line 64]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "TSbucketSet"

[line 42]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$tsBucketSetHorizon =

[line 53]

Variable that contains pointer to horizon (object)

Tags:

access:

public

Type:

object

[ Top ]

$tsBucketSetHorizonID =

[line 58]

Variable that contains pointer to horizon (ID)

Tags:

access:

public

Type:

int

[ Top ]

$tsBucketSetID =

[line 48]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

Class Methods

method createTSbucketSet [line 101]

object created createTSbucketSet(
object
$this->tsBucketSetHorizon)

TSbucketSet object creation function

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

<?php
$aVars = array("tsBucketSetHorizon"=>$oTShorizon);
$oTSbucketSet = new TSbucketSet($aVars);
echo $oTSbucketSet->createTSbucketSet()->tsBucketSetID;
// bucketsetID
?>

Tags:

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

Parameters:

object

$this->tsBucketSetHorizon

horizon of the bucket set (required)

[ Top ]

method deleteTSbucketSet [line 217]

bool deleteTSbucketSet(
int
$this->tsBucketSetID)

TSbucketSet object deletion function

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

<?php
$aVars = array("tsBucketSetID" => 12);
$oTSbucketSet = new TSbucketSet($aVars);
echo $oTSbucketSet->deleteTSbucketSet();
// 1
?>

Tags:

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

Parameters:

int

$this->tsBucketSetID

ID of the bucket set to be deleted (required)

[ Top ]

method getTSbucketSet [line 259]

object TSbucketSet getTSbucketSet(
int
$this->tsBucketSetID)

TSbucketSet object obtention function

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

<?php
$aVars = array("tsBucketSetID" => 12);
$oTSbucketSet = new TSbucketSet($aVars);
echo $oTSbucketSet->getTSbucketSet()->tsBucketSetHorizon->tsHorizonCode;
// fooCode
?>

Tags:

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

Parameters:

int

$this->tsBucketSetID

ID of the bucket set to get (required)

[ Top ]

method updateTSbucketSet [line 156]

object updated updateTSbucketSet(
int
$this->tsBucketSetID, object
$this->tsBucketSetHorizon)

TSbucketSet object update function

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

<?php
$aVars = array("tsBucketSetID" => 12,
"tsBucketSetHorizon" => $oTShorizon);
$oTSbucketSet = new TSbucketSet($aVars);
echo $oTSbucketSet->updateTSbucketSet()->tsBucketSetID;
// 12
?>

Tags:

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

Parameters:

int	$this->tsBucketSetID	ID of the bucket set to be updated (required)
object	$this->tsBucketSetHorizon	horizon of teh bucket set (required)

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:30:51 +0200 by phpDocumentor 1.4.1