Class: Estate_GoodsAmenities

Source Location: /Estate_GoodsAmenities.php

Class Overview

PHP_Objects
   |
   --Estate_GoodsAmenities

Created on 05 may 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

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 21]
Created on 05 may 09

This class manages Real Estate Goods Amenities objects (swimming pool, barbecue, parking, ... ).

CHANGES: 1.1 -> 1.2: 08 may 09 Added AmenityAdd() function Added debug value Modification: AmenitiesList() -> added $order and $orderrow variables 1.0 -> 1.1: 06 may 09 Added to RealEstates package function AmenitiesList() added

Tags:

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

[ Top ]

Class Variables

$database = "estates"

[line 27]

Variable that contains database name

Tags:

access:

protected

Type:

string

[ Top ]

$goodamenitydescr =

[line 51]

Variable that contains good amenity description

Tags:

access:

protected

Type:

string

[ Top ]

$goodamenityID =

[line 39]

Variable that contains good amenity ID

Tags:

access:

protected

Type:

int

[ Top ]

$goodamenityname =

[line 45]

Variable that contains good amenity name

Tags:

access:

protected

Type:

string

[ Top ]

$table = "estate_goodsamenities"

[line 33]

Variable that contains table name

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

method AmenitiesList [line 131]

object good AmenitiesList(
[
$orderrow = "goodamenityname"], [
$order = "ASC"], string
$this->database, string
$this->table)

Good Amenities list obtention function

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

<?php
$oAmenity = new Estate_GoodsAmenities();
$oAmenity->AmenitiesList();
print_r($oAmenity->result);
// goodamenities array
?>

Tags:

return:	amenities object
since:	Version 1.1

Parameters:

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

[ Top ]

method AmenityAdd [line 182]

object good AmenityAdd(
string
$goodamenityname, [string
$goodamenitydescr = null], string
$this->database, string
$this->table)

Good Amenities list obtention function

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

<?php
$oAmenity = new Estate_GoodsAmenities();
$oAmenity->AmenityAdd($goodamenityname,$goodamenitydescr);
?>

Tags:

return:	amenity object
since:	Version 1.2

Parameters:

string	$this->database	database name
string	$this->table	table name
string	$goodamenityname	amenity name
string	$goodamenitydescr	amenity description

[ Top ]

method AmenitybyID [line 79]

object fetched AmenitybyID(

$amenityID, string
$this->database, string
$this->table, int
$goodamenityID)

Good Amenity by ID obtention function

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

<?php
$oAmenity = new Estate_GoodsAmenities();
print_r($oAmenity->AmenitybyID(2));
// goodamenityobject
?>

Tags:

return:	good amenity object
since:	Version 1.0

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$goodamenityID	ID of the good amenity to be fetched
	$amenityID

[ Top ]

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