Class: Links_Hardgoods_Owners

Source Location: /Links_Hardgoods_Owners.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 Links objects between Hardgoods and Owner.

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

$database = "itcontact"

[line 22]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 63]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$hardgoodID =

[line 39]

Variable that contains hardgood ID

Tags:

access:

public

Type:

int

[ Top ]

$linkID =

[line 34]

Variable that contains link ID

Tags:

access:

public

Type:

int

[ Top ]

$oHardgood =

[line 51]

Variable that contains hardgood object

Tags:

access:	public
uses:	Hardgoods

Type:

object

[ Top ]

$ownerID =

[line 44]

Variable that contains owner ID

Tags:

access:

public

Type:

int

[ Top ]

$result =

[line 57]

Variable that contains Select results

Tags:

access:

public

Type:

array

[ Top ]

$table = "links_hardgoodID_ownerID"

[line 27]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor __construct [line 88]

Links_Hardgoods_Owners __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("hardgoodID"=>12);
$oLinks_Hardgoods_Owners = new Links_Hardgoods_Owners($aParams);
echo $oLinks_Hardgoods_Owners->hardgoodID;
// 12
?>

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 135]

int getbyhardgood(
object
$this->oHardgood)

Link by hardgood obtention function

This function is used to get owner for a specified hardgood. Result is stored in $this->linkID, $this->ownerID and link ID is returned.

<?php
$aParams = array("hardgoodID"=>12);
$oLinks_Hardgoods_Owners = new Links_Hardgoods_Owners($aParams,"getbyhardgood");
echo $oLinks_Hardgoods_Owners->ownerID;
// [ownerID]
?>

Tags:

return:	ID of the fetched link
since:	Version 1.0
uses:	MySQL::SelectRow()
uses:	Hardgoods

Parameters:

object

$this->oHardgood

hardgood object to be searched

[ Top ]

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