Class: WBreport

Source Location: /WBreport.php

Class Overview

WBobject
   |
   --WBreport

This class manages WBreport objects. Settings for issuing a report in a given application.

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 32]
This class manages WBreport objects. Settings for issuing a report in a given application.

Created on 30 jun 09

Changes: 1.1 -> 1.2: 14 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.2
license:	GNU Public License

[ Top ]

Class Variables

$aObjects = array(
"wbReportFamily" => "WBreportFamily")

[line 75]

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

[line 70]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBreport"

[line 43]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbReportFamily =

[line 59]

Variable that contains family of the report

Tags:

access:

public

Type:

object

[ Top ]

$wbReportFamilyID =

[line 64]

Variable that contains family ID of the report

Tags:

access:

public

Type:

int

[ Top ]

$wbReportID =

[line 49]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$wbReportName =

[line 54]

Variable that contains report name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createWBreport [line 109]

object created createWBreport(
string
$this->wbReportName, object
$this->wbReportFamily)

WBreport object creation function

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

<?php
$aVars = array("wbReportName" => "fooName",
"wbReportFamily" => $oWBfamily);
$oWBreport = new WBreport($aVars);
echo $oWBreport->createWBreport()->wbReportID;
// reportID
?>

Tags:

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

Parameters:

string	$this->wbReportName	name of the report (required)
object	$this->wbReportFamily	family of the report (required)

[ Top ]

method deleteWBreport [line 247]

bool deleteWBreport(
int
$this->wbReportID)

WBreport object deletion function

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

<?php
$aVars = array("wbReportID" => 12);
$oWBreport = new WBreport($aVars);
echo $oWBreport->deleteWBreport();
// 1
?>

Tags:

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

Parameters:

int

$this->wbReportID

ID of the profiled user to be deleted (required)

[ Top ]

method getWBreport [line 290]

object WBreport getWBreport(
int
$this->wbReportID)

WBreport object obtention function

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

<?php
$aVars = array("wbReportID" => 12);
$oWBreport = new WBreport($aVars);
echo $oWBreport->getWBreport()->wbReportName;
// fooName
?>

Tags:

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

Parameters:

int

$this->wbReportID

ID of the profiled user to get (required)

[ Top ]

method updateWBreport [line 174]

object updated updateWBreport(
int
$this->wbReportID, string
$this->wbReportName, object
$this->wbReportFamily)

WBreport object update function

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

<?php
$aVars = array("wbReportID" => 12, "wbReportName" => "fooName",
"wbReportFamily" => $oWBreportFamily);
$oWBreport = new WBreport($aVars);
echo $oWBreport->updateWBreport()->wbReportID;
// 12
?>

Tags:

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

Parameters:

int	$this->wbReportID	ID of the report to be updated (required)
string	$this->wbReportName	name of the report (required)
object	$this->wbReportFamily	family of the report (required)

[ Top ]

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

Class: WBreport

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Methods

Class: WBobject

Class Details

Tags:

Class Variables

$aObjects = array( "wbReportFamily" => "WBreportFamily")

Tags:

$database = "prysma"

Tags:

$sIDrowname = "wbReportID"

Tags:

$table = "WBreport"

Tags:

$wbReportFamily =

Tags:

$wbReportFamilyID =

Tags:

$wbReportID =

Tags:

$wbReportName =

Tags:

Class Methods

method createWBreport [line 109]

Tags:

Parameters:

method deleteWBreport [line 247]

Tags:

Parameters:

method getWBreport [line 290]

Tags:

Parameters:

method updateWBreport [line 174]

Tags:

Parameters:

$aObjects = array(
"wbReportFamily" => "WBreportFamily")