Class: Estate_Buildings

Source Location: /Estate_Buildings.php

Class Overview

PHP_Objects
   |
   --Estate_Buildings

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 19]
Created on 04 may 09

This class manages Real Estate Buildings objects.

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

Tags:

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

[ Top ]

Class Variables

$buildingdescr =

[line 49]

Variable that contains building description

Tags:

access:

protected

Type:

string

[ Top ]

$buildingID =

[line 37]

Variable that contains building ID

Tags:

access:

protected

Type:

int

[ Top ]

$buildingname =

[line 43]

Variable that contains building name

Tags:

access:

protected

Type:

string

[ Top ]

$database = "estates"

[line 25]

Variable that contains database name

Tags:

access:

protected

Type:

string

[ Top ]

$inserted_ts =

[line 55]

Variable that contains row insertion timestamp

Tags:

access:

protected

Type:

int

[ Top ]

$table = "estate_buildings"

[line 31]

Variable that contains table name

Tags:

access:

protected

Type:

string

[ Top ]

$updated_ts =

[line 61]

Variable that contains row modification timestamp

Tags:

access:

protected

Type:

int

[ Top ]

Class Methods

method BuildingAdd [line 197]

object building BuildingAdd(
string
$buildingname, string
$buildingdescr, string
$this->database, string
$this->table)

Building add function

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

<?php
$oBuilding = new Estate_Buildings();
$oBuilding->BuildingAdd($buildingname,$buildingdescr);
?>

Tags:

return:	object
since:	Version 1.2

Parameters:

string	$this->database	database name
string	$this->table	table name
string	$buildingname	name of the building
string	$buildingdescr	decription of the building

[ Top ]

method BuildingbyID [line 90]

object fetched BuildingbyID(
int
$buildingID, string
$this->database, string
$this->table)

Building by ID obtention function

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

<?php
$oBuilding = new Estate_Buildings();
print_r($oBuilding->BuildingbyID(2));
// buildingobject
?>

Tags:

return:	floor object
since:	Version 1.0

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$buildingID	ID of the building to be fetched

[ Top ]

method BuildingList [line 146]

object building BuildingList(
string
$this->database, string
$this->table)

Buildings list obtention function

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

<?php
$oBuilding = new Estate_Buildings();
$oBuilding->BuildingList();
print_r($oBuilding->result);
// buildings array
?>

Tags:

return:	object
since:	Version 1.1

Parameters:

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

[ Top ]

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