Class: SOtype

Source Location: /SOtype.php

Class Overview

WBobject
   |
   --SOtype

This class manages SOtype objects. List of types that are available for supply orders.

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Inherited Methods

Class: WBobject

WBobject::__construct(): Construction function
WBobject::addToDB(): Rows insertion to database function
WBobject::deleteFromDB(): Rows deletion function
WBobject::getIDrowname(): ID rowname obtention function
WBobject::getObjects(): Objects list obtention function
WBobject::getUniqueFromDB(): Unique Row obtention function
WBobject::objectToArray(): Object to array transformation function
WBobject::updateDB(): Rows update function

Class Details

[line 31]
This class manages SOtype objects. List of types that are available for supply orders.

Created on 08 jul 09

Changes: 1.0 -> 1.1: 09 jul 09 updated: file is PEAR compatible

Tags:

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

[ Top ]

Class Variables

$aObjects = array()

[line 70]

Variable that contains objects list

Tags:

access:

protected

Type:

array

[ Top ]

$database = "prysma"

[line 37]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$sIDrowname = "soTypeID"

[line 65]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$soTypeCode =

[line 53]

Variable that contains code for the type

Tags:

access:

public

Type:

string

[ Top ]

$soTypeDescription =

[line 58]

Variable that contains description for the code

Tags:

access:

public

Type:

string

[ Top ]

$soTypeID =

[line 48]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$table = "SOtype"

[line 42]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createSOtype [line 103]

object created createSOtype(
string
$this->soTypeCode, string
$this->soTypeDescription)

SOtype object creation function

This function is used to create a SOtype object Result is stored in $this and object is returned

<?php
$aVars = array("soTypeCode" => "fooCode",
"soTypeDescription" => "barDescription");
$oSOtype = new SOtype($aVars);
echo $oSOtype->createSOtype()->soTypeID;
// typeID
?>

Tags:

return:	object or false
since:	Version 1.0
uses:	WBobject::addToDB()

Parameters:

string	$this->soTypeCode	code of the type (required)
string	$this->soTypeDescription	description of the type (required)

[ Top ]

method deleteSOtype [line 237]

bool deleteSOtype(
int
$this->soTypeID)

SOtype object deletion function

This function is used to delete a SOtype by its ID Result is returned

<?php
$aVars = array("soTypeID" => 12);
$oSOtype = new SOtype($aVars);
echo $oSOtype->deleteSOtype();
// 1
?>

Tags:

return:	true or false weither the object could be deleted or not
since:	Version 1.0
uses:	WBobject::deleteFromDB()

Parameters:

int

$this->soTypeID

ID of the type to be deleted (required)

[ Top ]

method getSOtype [line 278]

object SOtype getSOtype(
int
$this->soTypeID)

SOtype object obtention function

This function is used to get a SOtype by its ID Result is returned

<?php
$aVars = array("soTypeID" => 12);
$oSOtype = new SOtype($aVars);
echo $oSOtype->getSOtype()->soTypeCode;
// fooCode
?>

Tags:

return:	object
since:	Version 1.0
uses:	WBobject::getUniqueFromDB()

Parameters:

int

$this->soTypeID

ID of the type to get (required)

[ Top ]

method updateSOtype [line 168]

object updated updateSOtype(
int
$this->soTypeID, string
$this->soTypeCode, string
$this->soTypeDescription)

SOtype object update function

This function is used to update a SOtype Result is stored in $this and object is returned

<?php
$aVars = array("soTypeID" => 12, "soTypeCode" => "fooCode",
"soTypeDescription" => "barDescription");
$oSOstatus = new SOtype($aVars);
echo $oSOtype->updateSOtype()->soTypeID;
// 12
?>

Tags:

return:	object or false
since:	Version 1.0
uses:	WBobject::updateDB()

Parameters:

int	$this->soTypeID	ID of the type to be updated (required)
string	$this->soTypeCode	code of the type (required)
string	$this->soTypeDescription	description of the type (required)

[ Top ]

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