Class: SOstatus

Source Location: /SOstatus.php

Class Overview

WBobject
   |
   --SOstatus

This class manages SOstatus objects. List of status 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 SOstatus objects. List of status 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 74]

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 = "soStatusID"

[line 69]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$soStatusDescription =

[line 63]

Variable that contains description of the status

Tags:

access:

public

Type:

string

[ Top ]

$soStatusID =

[line 48]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$soStatusLong =

[line 58]

Variable that contains long code for the status

Tags:

access:

public

Type:

string

[ Top ]

$soStatusShort =

[line 53]

Variable that contains short code for the status

Tags:

access:

public

Type:

string

[ Top ]

$table = "SOstatus"

[line 42]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createSOstatus [line 108]

object created createSOstatus(
string
$this->soStatusShort, string
$this->soStatusLong, string
$this->soStatusDescription)

SOstatus object creation function

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

<?php
$aVars = array("soStatusShort" => "fooShort",
"soStatusLong" => "barLong", "soStatusDescription" => "fooDescription");
$oSOstatus = new SOstatus($aVars);
echo $oSOstatus->createSOstatus()->soStatusID;
// statusID
?>

Tags:

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

Parameters:

string	$this->soStatusShort	short name of status (required)
string	$this->soStatusLong	long name of status (required)
string	$this->soStatusDescription	description of status (required)

[ Top ]

method deleteSOstatus [line 267]

bool deleteSOstatus(
int
$this->soStatusID)

SOstatus object deletion function

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

<?php
$aVars = array("soStatusID" => 12);
$oSOstatus = new SOstatus($aVars);
echo $oSOstatus->deleteSOstatus();
// 1
?>

Tags:

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

Parameters:

int

$this->soStatusID

ID of the status to be deleted (required)

[ Top ]

method getSOstatus [line 308]

object SOstatus getSOstatus(
int
$this->soStatusID)

SOstatus object obtention function

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

<?php
$aVars = array("soStatusID" => 12);
$oSOstatus = new SOstatus($aVars);
echo $oSOstatus->getSOstatus()->soStatusShort;
// fooShort
?>

Tags:

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

Parameters:

int

$this->soStatusID

ID of the status to get (required)

[ Top ]

method updateSOstatus [line 187]

object updated updateSOstatus(
int
$this->soStatusID, string
$this->soStatusShort, string
$this->soStatusLong, string
$this->soStatusDescription)

SOstatus object update function

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

<?php
$aVars = array("soStatusID" => 12, "soStatusShort" => "fooShort",
"soStatusLong" => "barLong", "soStatusDescription" => "fooDescription");
$oSOstatus = new SOstatus($aVars);
echo $oSOstatus->updateSOstatus()->soStatusID;
// 12
?>

Tags:

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

Parameters:

int	$this->soStatusID	ID of the status to be updated (required)
string	$this->soStatusShort	short name of the status (required)
string	$this->soStatusLong	long name of the status (required)
string	$this->soStatusDescription	description of the status (required)

[ Top ]

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