Class: MacAddresses

Source Location: /MacAddresses.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 Mac Addresses 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
license:	GNU Public License

[ Top ]

Class Variables

$addressID =

[line 34]

Variable that contains address ID

Tags:

access:

public

Type:

int

[ Top ]

$database = "itcontact"

[line 22]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 68]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$hardgoodID =

[line 49]

Variable that contains hardgood ID

Tags:

access:

public

Type:

int

[ Top ]

$macaddress =

[line 39]

Variable that contains mac address string

Tags:

access:

public

Type:

string

[ Top ]

$oHardgood =

[line 56]

Variable that contains hardgood object

Tags:

access:	public
uses:	Hardgoods

Type:

object

[ Top ]

$result =

[line 62]

Variable that contains Select results

Tags:

access:

public

Type:

array

[ Top ]

$table = "macaddresses"

[line 27]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wifi =

[line 44]

Variable that contains switch defining if mac address is a wifi address

Tags:

access:

public

Type:

bool

[ Top ]

Class Methods

constructor __construct [line 93]

MacAddresses __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("macaddress"=>"A0B1C2D3E4F5");
$oMacAddresses = new MacAddresses($aParams);
echo $oMacAddresses->macaddress;
// A0B1C2D3E4F5
?>

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 getbyhardgood [line 139]

int getbyhardgood(
object
$this->oHardgood)

Mac address by hardgood obtention function

This function is used to get mac address for a specified hardgood. Result is stored in $this->value and returned.

<?php
$aParams = array("oHardgood"=>$oHardgood_object);
$oMacAddresses = new MacAddresses($aParams,"getbyhardgood");
echo $oMacAddresses->macaddress;
// A0B1C2D3E4F5
?>

Tags:

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

Parameters:

object

$this->oHardgood

hardgood to be fetched

[ Top ]

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