Class: Hardgoods

Source Location: /Hardgoods.php

Class Overview

Created on 01 mars 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Class Details

[line 16]
Created on 01 mars 09

This class manages Hardgoods objects.

Changes: 1.0 to 2.0: phpdoc compatible in the way to generate documentation

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	2.0
usedby:	MacAddresses::$oHardgood
usedby:	Links_Hardgoods_Owners::getbyhardgood()
license:	GNU Public License
usedby:	Links_Hardgoods_Owners::$oHardgood

[ Top ]

Class Variables

$bought_ts =

[line 49]

Variable that contains bought date in timestamp format

Tags:

access:

public

Type:

int

[ Top ]

$database = "itcontact"

[line 22]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 80]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$hardgoodID =

[line 34]

Variable that contains hardgood ID

Tags:

access:

public

Type:

int

[ Top ]

$modelID =

[line 39]

Variable that contains model ID

Tags:

access:

public

Type:

int

[ Top ]

$oBrand =

[line 62]

Variable that contains brand object

Tags:

access:	public
uses:	Brands

Type:

object

[ Top ]

$oModel =

[line 56]

Variable that contains model object

Tags:

access:	public
uses:	Hardgoods_Models

Type:

object

[ Top ]

$oType =

[line 68]

Variable that contains type object

Tags:

access:	public
uses:	Hardgoods_Types

Type:

object

[ Top ]

$result =

[line 74]

Variable that contains Select results

Tags:

access:

public

Type:

array

[ Top ]

$serial =

[line 44]

Variable that contains serial string

Tags:

access:

public

Type:

string

[ Top ]

$table = "hardgoods"

[line 27]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor __construct [line 105]

Hardgoods __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("serial"=>"abc1234");
$oHardgoods = new Hardgoods($aParams);
echo $oHardgoods->serial;
// abc1234
?>

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 getlist [line 155]

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

Hardgoods obtention function

This function is used to get hardgoods listing Result is stored in $this->result and fetched rows number is returned

<?php
$oHardgoods = new Hardgoods();
$oHardgoods->getlist();
print_r($oHardgoods->result);
// hardgoodslisting
?>

Tags:

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

Parameters:

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

[ Top ]

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