Class: SPcycleType

Source Location: /SPcycleType.php

Class Overview

WBobject
   |
   --SPcycleType

This class manages SPcycleType objects. Details of the type of cycles used with details on their frequencies and horizons used.

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 SPcycleType objects. Details of the type of cycles used with details on their frequencies and horizons used.

Created on 06 jul 09

Changes: 1.0 -> 1.1: 14 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 69]

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

[line 64]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$spCycleTypeDescription =

[line 58]

Variable that contains cycle type description

Tags:

access:

public

Type:

string

[ Top ]

$spCycleTypeID =

[line 48]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$spCycleTypeName =

[line 53]

Variable that contains cycle type name

Tags:

access:

public

Type:

string

[ Top ]

$table = "SPcycleType"

[line 42]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method createSPcycleType [line 106]

object created createSPcycleType(
string
$this->spCycleTypeName, string
$this->spCycleTypeDescription)

SPcycleType object creation function

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

<?php
$aVars = array(
"spCycleTypeName" => "fooName",
"spCycleTypeDescription" => "barDescription"
);
$oSPcycleType = new SPcycleType($aVars);
echo $oSPcycleType->createSPcycleType()->spCycleTypeID;
// cycletypeID
?>

Tags:

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

Parameters:

string	$this->spCycleTypeName	name of the cycle type (required)
string	$this->spCycleTypeDescription	description of the cycle type (required)

[ Top ]

method deleteSPcycleType [line 253]

bool deleteSPcycleType(
int
$this->spCycleTypeID)

SPcycleType object deletion function

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

<?php
$aVars = array("spCycleTypeID" => 12);
$oSPcycleType = new SPcycleType($aVars);
echo $oSPcycleType->deleteSPcycleType();
// 1
?>

Tags:

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

Parameters:

int

$this->spCycleTypeID

ID of the cycle type to be deleted (required)

[ Top ]

method getSPcycleType [line 295]

object SPcycleType getSPcycleType(
int
$this->spCycleTypeID)

SPcycleType object obtention function

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

<?php
$aVars = array("spCycleTypeID" => 12);
$oSPcycleType = new SPcycleType($aVars);
echo $oSPcycleType->getSPcycleType()->spCycleTypeName;
// fooName
?>

Tags:

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

Parameters:

int

$this->spCycleTypeID

ID of the cycle type to get (required)

[ Top ]

method updateSPcycleType [line 179]

object updated updateSPcycleType(
int
$this->spCycleTypeID, string
$this->spCycleTypeName, string
$this->spCycleTypeDescription)

SPcycleType object update function

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

<?php
$aVars = array(
"spCycleTypeID" => 12,
"spCycleTypeName" => "fooName",
"spCycleTypeDescription" => "barDescription"
);
$oSPcycleType = new SPcycleType($aVars);
echo $oSPcycleType->updateSPcycleType()->spCycleTypeID;
// 12
?>

Tags:

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

Parameters:

int	$this->spCycleTypeID	ID of the cycle type to be updated (required)
string	$this->spCycleTypeName	name of the cycle type (required)
string	$this->spCycleTypeDescription	description of the cycle type (required)

[ Top ]

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