Class: PHP_Objects

Source Location: /PHP_Objects.php

Class Overview

Created on 05 may 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Child classes:

Estate_Availabilities: Created on 05 may 09

Estate_Buildings: Created on 04 may 09

Estate_CitiesDescriptions: Created on 04 may 09

Estate_Floors: Created on 04 may 09

Estate_GoodPriceTypes: Created on 05 may 09

Estate_Goods: Created on 04 may 09

Estate_GoodsAmenities: Created on 05 may 09

Estate_GoodsLegalForms: Created on 05 may 09

Estate_HeatingSysTypes: Created on 04 may 09

Estate_Links_Goods_Amenities: Created on 05 may 09

Estate_Links_Goods_Buildings: Created on 05 may 09

Estate_Links_Goods_Photos: Created on 05 may 09

Estate_Links_Rooms_Equipments: Created on 05 may 09

Estate_Photos: Created on 04 may 09

Estate_RoomEquipments: Created on 04 may 09

Estate_Rooms: Created on 04 may 09

Estate_RoomTypes: Created on 05 may 09

Menus: Created on 06 apr 09

Class Details

[line 16]
Created on 05 may 09

This class manages PHP objects. This is the standard main object for the framework.

CHANGES: 1.0 -> 1.1: 07 may 09 added setDebug() function

Tags:

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

[ Top ]

Class Variables

$debug = false

[line 22]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$error =

[line 35]

Variable used to render errors

This variable contains the error message and the error number

Tags:

access:

public

Type:

array

[ Top ]

$result =

[line 28]

Variable used to store database results

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor __construct [line 60]

PHP_Objects __construct(
[array
$aParams = null], [string
$sAction = null])

Construction function

This function is used when object is generated. It places variables in "$this" var and can launch function

<?php
$aParams = array("goodname"=>"Maison ˆ Prilly");
$oGood = new Estate_Goods($aParams);
echo $oGood->goodname;
// Maison ˆ Prilly
?>

Tags:

since:

Version 1.0

Parameters:

array	$aParams	array containing variable names and their value ($variablename => $value)
string	$sAction	string containing action to perform on object creation

[ Top ]

method getDB [line 95]

string getDB(
)

Database obtention function

This function is used to get database string for used object. Result is returned

<?php
$oGood = new Estate_Goods();
echo $oGood->getDB();
// estates
?>

Tags:

return:	database name of the instancied object
since:	Version 1.0

[ Top ]

method getTable [line 125]

string getTable(
)

Table obtention function

This function is used to get table string for used object. Result is returned

<?php
$oGood = new Estate_Goods();
echo $oGood->getTable();
// estate_goods
?>

Tags:

return:	table name of the instancied object
since:	Version 1.0

[ Top ]

method setDebug [line 157]

object current setDebug(
[bool
$debugmode = true])

Debug setting function

This function is used to set debug mode. Result is stored in $this.

<?php
$oGood = new Estate_Goods();
$oGood->setDebug(true);
?>

Tags:

return:	object
since:	Version 1.1

Parameters:

bool

$debugmode

debug value

[ Top ]

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