Class: Estate_CitiesDescriptions

Source Location: /Estate_CitiesDescriptions.php

Class Overview

PHP_Objects
   |
   --Estate_CitiesDescriptions

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 Cities decriptions objects.

CHANGES: 1.2 -> 1.3: 08 may 09 Added DescriptionAdd() function Added debug value 1.1 -> 1.2: 07 may 09 Added DescriptionsList() 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

$citydescription =

[line 44]

Variable that contains city description

Tags:

access:

protected

Type:

string

[ Top ]

$citydescriptionID =

[line 38]

Variable that contains city description ID

Tags:

access:

protected

Type:

int

[ Top ]

$cityID =

[line 50]

Variable that contains city ID

Tags:

access:

protected

Type:

int

[ Top ]

$database = "estates"

[line 26]

Variable that contains database name

Tags:

access:

protected

Type:

string

[ Top ]

$table = "estate_citiesdescriptions"

[line 32]

Variable that contains table name

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

method DescriptionAdd [line 179]

object description DescriptionAdd(
string
$citydescription, int
$cityID, string
$this->database, string
$this->table)

Description add function

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

<?php
$oDescription = new Estate_CitiesDescriptions();
$oDescription->DescriptionAdd($citydescription,$cityID);
?>

Tags:

return:	object
since:	Version 1.3

Parameters:

string	$this->database	database name
string	$this->table	table name
string	$citydescription	description of the city
int	$cityID	ID of the city

[ Top ]

method DescriptionbyID [line 78]

object fetched DescriptionbyID(
int
$descrID, string
$this->database, string
$this->table)

Description by ID obtention function

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

<?php
$oDescription = new Estate_CitiesDescriptions();
print_r($oDescription->DescriptionbyID(2));
// citydescriptionobject
?>

Tags:

return:	description object
since:	Version 1.0

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$descrID	ID of the description to be fetched

[ Top ]

method DescriptionsList [line 130]

object description DescriptionsList(
string
$this->database, string
$this->table)

Descriptions list function

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

<?php
$oDescription = new Estate_CitiesDescriptions();
$oDescription->DescriptionsList();
print_r($oDescription->result);
// citydescriptions 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:03 +0200 by phpDocumentor 1.4.1