Class: EW_Manufacturer_Models

Source Location: /EW_Manufacturer_Models.php

Class Overview

Created on 01 mars 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Class Details

[line 26]
Created on 01 mars 09

This class manages EVS Window Models objects.

Changes: 2.2 to 2.3: 05 jun 09 added $man_id variable added $oManufacturer variable 2.1 to 2.2: 26 may 09 added ModelByCode() function added ModelAdd() function added ModelUpdate() function renamed listmodels() function to ModelsList() improved ModelsList() (more variable fetched from DB) 2.0 to 2.1: 25 may 09 added all variables of the objects changed GetByID() function name to ModelByID() ModelByID() function improvements (more variables fetched from DB) 1.0 to 2.0: phpdoc compatible in the way to generate documentation

Tags:

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

[ Top ]

Class Variables

$database = "evswindowcom"

[line 32]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 245]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$man_code =

[line 61]

Variable that contains manufacturer code

Tags:

deprecated:
access:	public

Type:

string

[ Top ]

$man_id =

[line 49]

Variable that contains manufacturer ID

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_autonomous_water_facility = false

[line 141]

Variable that contains flag defining if the model has an autonomous water system

Tags:

access:

public

Type:

bool

[ Top ]

$man_mod_auto_clean = false

[line 146]

Variable that contains flag defining if the model has an automatic cleaning system

Tags:

access:

public

Type:

bool

[ Top ]

$man_mod_boiler_capacity =

[line 191]

Variable that contains boiler capacity of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_canister_capacity =

[line 186]

Variable that contains canister capacity of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_code =

[line 71]

Variable that contains model code

Tags:

access:

public

Type:

string

[ Top ]

$man_mod_cold_beverage_facility = false

[line 136]

Variable that contains flag defining if the model has facility to do cold beverage

Tags:

access:

public

Type:

bool

[ Top ]

$man_mod_cup_capacity =

[line 206]

Variable that contains cup capacity of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_cup_dispenser = false

[line 126]

Variable that contains flag defining if the model has a cup dispenser

Tags:

access:

public

Type:

bool

[ Top ]

$man_mod_depth =

[line 91]

Variable that contains depth of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_direct_hot_water_outlet =

[line 216]

Variable that contains quantity of direct hot water outlet of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_electricty_id =

[line 166]

Variable that contains ID of the electricity system (EW_Manufacturer_Model_Electricities() object)

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_fresh_milk_beverage =

[line 226]

Variable that contains quantity of milk beverage capacity of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_height =

[line 86]

Variable that contains height of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_id =

[line 44]

Variable that contains model ID

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_max_dia =

[line 156]

Variable that contains diameter of the dispense area

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_max_height =

[line 151]

Variable that contains height of the dispense area

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_multiple_brew =

[line 221]

Variable that contains quantity of brew of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_name =

[line 66]

Variable that contains model name

Tags:

access:

public

Type:

string

[ Top ]

$man_mod_nb_canisters =

[line 116]

Variable that contains quantity of canisters of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_nb_mixers =

[line 121]

Variable that contains quantity of mixers of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_nb_preselections =

[line 111]

Variable that contains quantity of preselections of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_nb_selections =

[line 106]

Variable that contains quantity of selections of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_nes_approval =

[line 161]

Variable that contains flag defining if the model has been approved by Nestle

Tags:

access:

public

Type:

bool

[ Top ]

$man_mod_overview =

[line 81]

Variable that contains overview of the model

Tags:

access:

public

Type:

string

[ Top ]

$man_mod_power =

[line 171]

Variable that contains power of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_stirrer_capacity =

[line 211]

Variable that contains stirrer capacity of the model

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_stirrer_dispenser = false

[line 131]

Variable that contains flag defining if the model has a stirrer dispenser

Tags:

access:

public

Type:

bool

[ Top ]

$man_mod_throughput =

[line 201]

Variable that contains throughput of the model in cups per hour

Tags:

access:

public

Type:

int

[ Top ]

$man_mod_version =

[line 76]

Variable that contains version of the model

Tags:

access:

public

Type:

string

[ Top ]

$man_mod_water_pressure_max =

[line 181]

Variable that contains maximal water pressure of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_water_pressure_min =

[line 176]

Variable that contains minimal water pressure of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_water_reservoir_capacity =

[line 196]

Variable that contains water reservoir capacity of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_weight =

[line 101]

Variable that contains weight of the model

Tags:

access:

public

Type:

float

[ Top ]

$man_mod_width =

[line 96]

Variable that contains width of the model

Tags:

access:

public

Type:

float

[ Top ]

$oManufacturer =

[line 55]

Variable that contains manufacturer object

Tags:

access:	public
uses:	EW_Manufacturers

Type:

object

[ Top ]

$peo_id_controler =

[line 233]

Variable that contains controller ID (from EW_People)

NEEDS TO BE PLACED IN A SEPARATE OBJECT

Tags:

deprecated:
access:	public

Type:

int

[ Top ]

$result =

[line 239]

Variable that contains Select results

Tags:

access:

public

Type:

array

[ Top ]

$table = "ew_manufacturer_model"

[line 37]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor __construct [line 270]

EW_Manufacturer_Models __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("man_mod_name"=>"Model name");
$oEW_Manufacturer_Models = new EW_Manufacturer_Models($aParams);
echo $oEW_Manufacturer_Models->man_mod_name;
// Model name
?>

Tags:

since:	Version 1.0
uses:	Strings

Parameters:

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

[ Top ]

method ModelAdd [line 864]

int ModelAdd(
string
$this->database, string
$this->table, string
$this->man_code, string
$this->man_mod_name, string
$this->man_mod_code, string
$this->man_mod_version, string
$this->man_mod_overview, float
$this->man_mod_height, float
$this->man_mod_depth, float
$this->man_mod_width, float
$this->man_mod_weight, int
$this->man_mod_nb_selections, int
$this->man_mod_nb_preselections, int
$this->man_mod_nb_canisters, int
$this->man_mod_nb_mixers, bool
$this->man_mod_cup_dispenser, bool
$this->man_mod_stirrer_dispenser, bool
$this->man_mod_cold_beverage_facility, bool
$this->man_mod_autonomous_water_facility, bool
$this->man_mod_auto_clean, float
$this->man_mod_max_height, float
$this->man_mod_max_dia, bool
$this->man_mod_nes_approval, int
$this->man_mod_electricity_id, int
$this->man_mod_power, float
$this->man_mod_water_pressure_min, float
$this->man_mod_water_pressure_max, float
$this->man_mod_canister_capacity, float
$this->man_mod_boiler_capacity, float
$this->man_mod_water_reservoir_capacity, int
$this->man_mod_throughput, int
$this->man_mod_cup_capacity, int
$this->man_mod_stirrer_capacity, int
$this->man_mod_direct_hot_water_outlet, int
$this->man_mod_multiple_brew, int
$this->man_mod_fresh_milk_beverage, int
$this->peo_id_controler)

Model addition function

This function is used to add a model to database. Result is returned.

<?php
$aValues = array("man_code"=>$man_code,"man_mod_name"=>$man_mod_name,...,"peo_id_controler"=>$peo_id_controler);
$oEW_Manufacturer_Models = new EW_Manufacturer_Models($aValues);
echo $oEW_Manufacturer_Models->ModelAdd();
// modelid
?>

Tags:

return:	ID of the model
since:	Version 2.2
uses:	MySQL::InsertDatas()

Parameters:

string	$this->database	database name
string	$this->table	table name
string	$this->man_code	code of the manufacturer of the model (required)
string	$this->man_mod_name	name of the model (required)
string	$this->man_mod_code	code of the model (required)
string	$this->man_mod_version	version of the model (required)
string	$this->man_mod_overview	overview of the model (required)
float	$this->man_mod_height	height of the model (required)
float	$this->man_mod_depth	depth of the model (required)
float	$this->man_mod_width	width of the model (required)
float	$this->man_mod_weight	weight of the model (required)
int	$this->man_mod_nb_selections	number of selections of the model (required)
int	$this->man_mod_nb_preselections	number of preselections of the model (required)
int	$this->man_mod_nb_canisters	number of canisters of the model (required)
int	$this->man_mod_nb_mixers	number of mixers of the model (required)
bool	$this->man_mod_cup_dispenser	flag defining if the model has a cup dispenser (required)
bool	$this->man_mod_stirrer_dispenser	flag defining if the model has a stirrer dispenser (required)
bool	$this->man_mod_cold_beverage_facility	flag defining if the model has a cold beverage facility (required)
bool	$this->man_mod_autonomous_water_facility	flag defining if the model has an autonomous water facility (required)
bool	$this->man_mod_auto_clean	flag defining if the model has an automatic cleaning system (required)
float	$this->man_mod_max_height	maximum height of the dispenser of the model (required)
float	$this->man_mod_max_dia	maximum diameter of the dispenser of the model (required)
bool	$this->man_mod_nes_approval	flag defining if the model has been approved by Nestle (required)
int	$this->man_mod_electricity_id	ID of the electricity system of the model (required)
int	$this->man_mod_power	power of the model (required)
float	$this->man_mod_water_pressure_min	minimal water pressure of the model (required)
float	$this->man_mod_water_pressure_max	maximal water pressure of the model (required)
float	$this->man_mod_canister_capacity	capacity of the canister of the model (required)
float	$this->man_mod_boiler_capacity	capacity of the boiler of the model (required)
float	$this->man_mod_water_reservoir_capacity	capacity of the water reservoir of the model (required)
int	$this->man_mod_throughput	throughput of the model in cups per hour (required)
int	$this->man_mod_cup_capacity	cup capacity of the model (required)
int	$this->man_mod_stirrer_capacity	stirrer capacity of the model (required)
int	$this->man_mod_direct_hot_water_outlet	direct hot water outlet quantity (required)
int	$this->man_mod_multiple_brew	quantity of brew of the model (required)
int	$this->man_mod_fresh_milk_beverage	quantity of fresh milk beverage (required)
int	$this->peo_id_controler	ID of the controler of the model (required)

[ Top ]

method ModelByCode [line 451]

string ModelByCode(
string
$this->man_mod_code, string
$this->database, string
$this->table)

Model by model code obtention function

This function is used to get a EW_Manufacturer_Model by its model code. Result is stored in $this and model name is returned

<?php
$aParams = array("man_mod_code"=>"foocode");
$oEW_Manufacturer_Models = new EW_Manufacturer_Models($aParams,"ModelByCode");
echo $oEW_Manufacturer_Models->man_mod_name;
// Model name
?>

Tags:

return:	model name
since:	Version 2.1
uses:	MySQL::SelectRow()

Parameters:

string	$this->man_mod_code	code of the model to be fetched (required)
string	$this->database	database name
string	$this->table	table name

[ Top ]

method ModelByID [line 318]

string ModelByID(
int
$this->man_mod_id, string
$this->database, string
$this->table)

Model by ID obtention function

This function is used to get a EW_Manufacturer_Model by its ID. Result is stored in $this and model name is returned

<?php
$aParams = array("man_mod_id"=>12);
$oEW_Manufacturer_Models = new EW_Manufacturer_Models($aParams,"ModelByID");
echo $oEW_Manufacturer_Models->man_mod_name;
// Model name
?>

Tags:

return:	model name
since:	Version 1.0
uses:	MySQL::SelectRow()

Parameters:

int	$this->man_mod_id	ID of the model to be fetched (required)
string	$this->database	database name
string	$this->table	table name

[ Top ]

method ModelsList [line 575]

int ModelsList(
string
$this->database, string
$this->table)

Model listing function

This function is used to get a listing of all models. Result is stored in $this->result and number of fetched rows is returned.

<?php
$oEW_Manufacturer_Models = new EW_Manufacturer_Models();
$oEW_Manufacturer_Models->ModelsList();
print_r($oEW_Manufacturer_Models->result);
// [modelslisting]
?>

Tags:

return:	number of fetched rows
since:	Version 1.0
uses:	MySQL::SelectRow()

Parameters:

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

[ Top ]

method ModelUpdate [line 703]

int ModelUpdate(
string
$this->database, string
$this->table, int
$this->man_mod_id, string
$this->man_code, string
$this->man_mod_name, string
$this->man_mod_code, string
$this->man_mod_version, string
$this->man_mod_overview, float
$this->man_mod_height, float
$this->man_mod_depth, float
$this->man_mod_width, float
$this->man_mod_weight, int
$this->man_mod_nb_selections, int
$this->man_mod_nb_preselections, int
$this->man_mod_nb_canisters, int
$this->man_mod_nb_mixers, bool
$this->man_mod_cup_dispenser, bool
$this->man_mod_stirrer_dispenser, bool
$this->man_mod_cold_beverage_facility, bool
$this->man_mod_autonomous_water_facility, bool
$this->man_mod_auto_clean, float
$this->man_mod_max_height, float
$this->man_mod_max_dia, bool
$this->man_mod_nes_approval, int
$this->man_mod_electricity_id, int
$this->man_mod_power, float
$this->man_mod_water_pressure_min, float
$this->man_mod_water_pressure_max, float
$this->man_mod_canister_capacity, float
$this->man_mod_boiler_capacity, float
$this->man_mod_water_reservoir_capacity, int
$this->man_mod_throughput, int
$this->man_mod_cup_capacity, int
$this->man_mod_stirrer_capacity, int
$this->man_mod_direct_hot_water_outlet, int
$this->man_mod_multiple_brew, int
$this->man_mod_fresh_milk_beverage, int
$this->peo_id_controler)

Model modification function

This function is used to update a model to database. Result is returned.

<?php
$aValues = array("man_mod_id"=>$man_mod_id,"man_code"=>$man_code,"man_mod_name"=>$man_mod_name,...,"peo_id_controler"=>$peo_id_controler);
$oEW_Manufacturer_Models = new EW_Manufacturer_Models($aValues);
echo $oEW_Manufacturer_Models->ModelUpdate();
// modelid
?>

Tags:

return:	ID of the model
since:	Version 2.2
uses:	MySQL::UpdateRow()

Parameters:

string	$this->database	database name
string	$this->table	table name
int	$this->man_mod_id	ID of model (required)
string	$this->man_code	code of the manufacturer of the model (required)
string	$this->man_mod_name	name of the model (required)
string	$this->man_mod_code	code of the model (required)
string	$this->man_mod_version	version of the model (required)
string	$this->man_mod_overview	overview of the model (required)
float	$this->man_mod_height	height of the model (required)
float	$this->man_mod_depth	depth of the model (required)
float	$this->man_mod_width	width of the model (required)
float	$this->man_mod_weight	weight of the model (required)
int	$this->man_mod_nb_selections	number of selections of the model (required)
int	$this->man_mod_nb_preselections	number of preselections of the model (required)
int	$this->man_mod_nb_canisters	number of canisters of the model (required)
int	$this->man_mod_nb_mixers	number of mixers of the model (required)
bool	$this->man_mod_cup_dispenser	flag defining if the model has a cup dispenser (required)
bool	$this->man_mod_stirrer_dispenser	flag defining if the model has a stirrer dispenser (required)
bool	$this->man_mod_cold_beverage_facility	flag defining if the model has a cold beverage facility (required)
bool	$this->man_mod_autonomous_water_facility	flag defining if the model has an autonomous water facility (required)
bool	$this->man_mod_auto_clean	flag defining if the model has an automatic cleaning system (required)
float	$this->man_mod_max_height	maximum height of the dispenser of the model (required)
float	$this->man_mod_max_dia	maximum diameter of the dispenser of the model (required)
bool	$this->man_mod_nes_approval	flag defining if the model has been approved by Nestle (required)
int	$this->man_mod_electricity_id	ID of the electricity system of the model (required)
int	$this->man_mod_power	power of the model (required)
float	$this->man_mod_water_pressure_min	minimal water pressure of the model (required)
float	$this->man_mod_water_pressure_max	maximal water pressure of the model (required)
float	$this->man_mod_canister_capacity	capacity of the canister of the model (required)
float	$this->man_mod_boiler_capacity	capacity of the boiler of the model (required)
float	$this->man_mod_water_reservoir_capacity	capacity of the water reservoir of the model (required)
int	$this->man_mod_throughput	throughput of the model in cups per hour (required)
int	$this->man_mod_cup_capacity	cup capacity of the model (required)
int	$this->man_mod_stirrer_capacity	stirrer capacity of the model (required)
int	$this->man_mod_direct_hot_water_outlet	direct hot water outlet quantity (required)
int	$this->man_mod_multiple_brew	quantity of brew of the model (required)
int	$this->man_mod_fresh_milk_beverage	quantity of fresh milk beverage (required)
int	$this->peo_id_controler	ID of the controler of the model (required)

[ Top ]

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