Class: WBreportFamily

Source Location: /WBreportFamily.php

Class Overview

WBobject
   |
   --WBreportFamily

This class manages WBreportFamily objects. Families of reports used for describing and grouping the reports. Must be using the same horizon type.

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 33]
This class manages WBreportFamily objects. Families of reports used for describing and grouping the reports. Must be using the same horizon type.

Created on 23 jun 09

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: getWBreportFamily() function

Tags:

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

[ Top ]

Class Variables

$aObjects = array()

[line 66]

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

[line 61]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBreportFamily"

[line 44]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbReportFamilyID =

[line 50]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$wbReportFamilyName =

[line 55]

Variable that contains report family name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createWBreportFamily [line 98]

object created createWBreportFamily(
string
$this->wbReportFamilyName)

WBreportFamily object creation function

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

<?php
$aVars = array("wbReportFamilyName" => "FooFamily");
$oWBreportFamily = new WBreportFamily($aVars);
echo $oWBreportFamily->createWBreportFamily()->wbReportFamilyID;
// reportfamilyID
?>

Tags:

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

Parameters:

string

$this->wbReportFamilyName

name of the report family (required)

[ Top ]

method deleteWBreportFamily [line 213]

bool deleteWBreportFamily(
int
$this->wbReportFamilyID)

WBreportFamily object deletion function

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

<?php
$aVars = array("wbReportFamilyID" => 12);
$oWBreportFamily = new WBreportFamily($aVars);
echo $oWBreportFamily->deleteWBreportFamily();
// 1
?>

Tags:

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

Parameters:

int

$this->wbReportFamilyID

ID of the report family to be deleted (required)

[ Top ]

method getWBprofiledUser [line 255]

object WBreportFamily getWBprofiledUser(
int
$this->wbReportFamilyID)

WBreport object obtention function

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

<?php
$aVars = array("wbReportFamilyID" => 12);
$oWBreportFamily = new WBreportFamily($aVars);
echo $oWBreportFamily->getWBreportFamily()->wbReportFamilyName;
// fooName
?>

Tags:

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

Parameters:

int

$this->wbReportFamilyID

ID of the profiled user to get (required)

[ Top ]

method updateWBreportFamily [line 153]

object updated updateWBreportFamily(
int
$this->wbReportFamilyID, string
$this->wbReportFamilyName)

WBreportFamily object update function

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

<?php
$aVars = array(
"wbReportFamilyID" => 12, "wbReportFamilyName" => "fooFamily"
);
$oWBreportFamily = new WBreportFamily($aVars);
echo $oWBreportFamily->updateWBreportFamily()->wbReportFamilyID;
// 12
?>

Tags:

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

Parameters:

int	$this->wbReportFamilyID	ID of the report family to be updated (required)
string	$this->wbReportFamilyName	Name of the report family (required)

[ Top ]

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