Class: Estate_HeatingSysTypes

Source Location: /Estate_HeatingSysTypes.php

Class Overview

PHP_Objects
   |
   --Estate_HeatingSysTypes

Created on 04 may 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Inherited Variables

Class: PHP_Objects

PHP_Objects::$debug
PHP_Objects::$error
PHP_Objects::$result

Inherited Methods

Class: PHP_Objects

PHP_Objects::__construct(): Construction function
PHP_Objects::getDB(): Database obtention function
PHP_Objects::getTable(): Table obtention function
PHP_Objects::setDebug(): Debug setting function

Class Details

[line 20]
Created on 04 may 09

This class manages Real Estate Heating systems types objects.

CHANGES: 1.2 -> 1.3: 08 may 09 Added HeatingSysTypeAdd() function Added debug value 1.1 -> 1.2: 07 may 09 Added HeatingSysTypesList() function 1.0 -> 1.1: 06 may 09 Added to RealEstates package

Tags:

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

[ Top ]

Class Variables

$database = "estates"

[line 26]

Variable that contains database name

Tags:

access:

protected

Type:

string

[ Top ]

$heatingsystypedescr =

[line 50]

Variable that contains heating system type description

Tags:

access:

protected

Type:

string

[ Top ]

$heatingsystypeID =

[line 38]

Variable that contains heating system type ID

Tags:

access:

protected

Type:

int

[ Top ]

$heatingsystypename =

[line 44]

Variable that contains heating system type name

Tags:

access:

protected

Type:

string

[ Top ]

$table = "estate_heatingsystypes"

[line 32]

Variable that contains table name

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

method HeatingSysTypeAdd [line 179]

object fetched HeatingSysTypeAdd(
string
$heatingsystypename, [string
$heatingsystypedescr = null], string
$this->database, string
$this->table)

Heating system type add function

This function is used to add a heating system type to database. Result is stored in $this and returned

<?php
$oHeatingSysType = new Estate_HeatingSysTypes();
$oHeatingSysType->HeatingSysTypeAdd($typename,$typedescr);
?>

Tags:

return:	heating system type object
since:	Version 1.3

Parameters:

string	$this->database	database name
string	$this->table	table name
string	$heatingsystypename	heating system type name
string	$heatingsystypedescr	heating system type description

[ Top ]

method HeatingSysTypebyID [line 78]

object fetched HeatingSysTypebyID(
int
$typeID, string
$this->database, string
$this->table)

Heating system type by ID obtention function

This function is used to get heating system type object by its ID from database. Result is stored in $this and returned

<?php
$oHeatingSysType = new Estate_HeatingSysTypes();
print_r($oHeatingSysType->HeatingSysTypebyID(2));
// heatingsystypeobject
?>

Tags:

return:	heating system type object
since:	Version 1.0

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$typeID	ID of the heating system type to be fetched

[ Top ]

method HeatingSysTypesList [line 130]

object fetched HeatingSysTypesList(
string
$this->database, string
$this->table)

Heating system types list function

This function is used to get heating system types list from database. Result is stored in $this and returned

<?php
$oHeatingSysType = new Estate_HeatingSysTypes();
$oHeatingSysType->HeatingSysTypesList();
print_r($oHeatingSysType->result);
// heatingsystypes array
?>

Tags:

return:	heating system type object
since:	Version 1.2

Parameters:

string	$this->database	database name
string	$this->table	table name

[ Top ]

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