Class: Estate_Floors

Source Location: /Estate_Floors.php

Class Overview

PHP_Objects
   |
   --Estate_Floors

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 Floors objects.

CHANGES: 1.1 -> 1.2: 08 may 09 Added to FloorAdd() 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.1
license:	GNU Public License

[ Top ]

Class Variables

$buildingID =

[line 55]

Variable that contains building ID

Tags:

access:

protected

Type:

int

[ Top ]

$database = "estates"

[line 25]

Variable that contains database name

Tags:

access:

protected

Type:

string

[ Top ]

$floordescr =

[line 49]

Variable that contains floor description

Tags:

access:

protected

Type:

string

[ Top ]

$floorID =

[line 37]

Variable that contains floor ID

Tags:

access:

protected

Type:

int

[ Top ]

$floorname =

[line 43]

Variable that contains floor name

Tags:

access:

protected

Type:

string

[ Top ]

$level =

[line 61]

Variable that contains level of the floor

Tags:

access:

protected

Type:

int

[ Top ]

$table = "estate_floors"

[line 31]

Variable that contains table name

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

method FloorAdd [line 198]

object floor FloorAdd(
string
$floorname, string
$floordescr, int
$buildingID, int
$level, string
$this->database, string
$this->table)

Floor add function

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

<?php
$oFloor = new Estate_Floors();
$oFloor->FloorAdd($floorname,$floordescr,$buildingID,$level);
?>

Tags:

return:	object
since:	Version 1.2

Parameters:

string	$this->database	database name
string	$this->table	table name
string	$floorname	floor name
string	$floordescr	floor description
int	$buildingID	ID of the building where the floor is
int	$level	level of the floor

[ Top ]

method FloorbyID [line 89]

object fetched FloorbyID(
int
$floorID, string
$this->database, string
$this->table)

Floor by ID obtention function

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

<?php
$oFloor = new Estate_Floors();
print_r($oFloor->FloorbyID(2));
// floorobject
?>

Tags:

return:	floor object
since:	Version 1.0

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$floorID	ID of the floor to be fetched

[ Top ]

method FloorsList [line 145]

object floor FloorsList(
string
$this->database, string
$this->table)

Floors list function

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

<?php
$oFloor = new Estate_Floors();
$oFloor->FloorsList();
print_r($oFloor->result);
// floors 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