Class: Estate_RoomEquipments

Source Location: /Estate_RoomEquipments.php

Class Overview

PHP_Objects
   |
   --Estate_RoomEquipments

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

CHANGES: 1.2 -> 1.3: 08 may 09 Added EquipmentAdd() function Added debug variable 1.1 -> 1.2: 07 may 09 Added EquipmentsList() 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 ]

$inserted_ts =

[line 56]

Variable that contains row insertion timestamp

Tags:

access:

protected

Type:

int

[ Top ]

$roomequipmentdescr =

[line 50]

Variable that contains room equipment description

Tags:

access:

protected

Type:

string

[ Top ]

$roomequipmentID =

[line 38]

Variable that contains room equipment ID

Tags:

access:

protected

Type:

int

[ Top ]

$roomequipmentname =

[line 44]

Variable that contains room equipment name

Tags:

access:

protected

Type:

string

[ Top ]

$table = "estate_roomequipments"

[line 32]

Variable that contains table name

Tags:

access:

protected

Type:

string

[ Top ]

$updated_ts =

[line 62]

Variable that contains row modification timestamp

Tags:

access:

protected

Type:

int

[ Top ]

Class Methods

method EquipmentAdd [line 197]

object equipment EquipmentAdd(

$roomequipmentname, [
$roomequipmentdescr = null], string
$this->database, string
$this->table)

Room equipments list function

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

<?php
$oEquip = new Estate_RoomEquipments();
$oEquip->EquipmentAdd($roomequipmentname,$roomequipmentdescr);
print_r($oEquip->result);
// roomequipments array
?>

Tags:

return:	object
since:	Version 1.3

Parameters:

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

[ Top ]

method EquipmentbyID [line 90]

object fetched EquipmentbyID(
int
$equipID, string
$this->database, string
$this->table)

Room equipment by ID obtention function

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

<?php
$oEquip = new Estate_RoomEquipments();
print_r($oEquip->EquipmentbyID(2));
// roomequipmentobject
?>

Tags:

return:	equipment object
since:	Version 1.0

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$equipID	ID of the equipment to be fetched

[ Top ]

method EquipmentsList [line 146]

object equipment EquipmentsList(
string
$this->database, string
$this->table)

Room equipments list function

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

<?php
$oEquip = new Estate_RoomEquipments();
$oEquip->EquipmentsList();
print_r($oEquip->result);
// roomequipments array
?>

Tags:

return:	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:07 +0200 by phpDocumentor 1.4.1