SupplyPlans
[ class tree: SupplyPlans ] [ index: SupplyPlans ] [ all elements ]
Packages:
rootpackage
Common
Files
Geographical
Graphical
HTML
Network
RealEstates
Strings
SupplyOrders
SupplyPlans
TimedSeries
WorkBench


Files:
SPcycle.php
SPcycles.php
SPcycleType.php
SPcycleTypes.php
SPitem.php
SPitems.php
SPitemSet.php
SPitemSets.php
SPitemType.php
SPitemTypes.php
SPsetup.php
SPsetups.php
SPstatus.php
SPstatuses.php

Classes:
SPcycle
SPcycles
SPcycleType
SPcycleTypes
SPitem
SPitems
SPitemSet
SPitemSets
SPitemType
SPitemTypes
SPsetup
SPsetups
SPstatus
SPstatuses

Class: SPstatus

Source Location: /SPstatus.php

Class Overview

WBobject
   |
   --SPstatus

This class manages SPstatus objects. Possible status that can qualify the progress of the activity that is performaed on an item.


Author(s):

Version:

  • 1.1

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 30]
This class manages SPstatus objects. Possible status that can qualify the progress of the activity that is performaed on an item.

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(
        "spStatusCyclePattern" => "SPcycleType")

[line 78]

Variable that contains objects list



Tags:

access:  protected

Type:   array


[ Top ]

$database =  "prysma"

[line 36]

Variable that contains database name



Tags:

access:  public

Type:   string


[ Top ]

$sIDrowname =  "spStatusID"

[line 73]

Variable that contains ID rowname



Tags:

access:  protected

Type:   string


[ Top ]

$spStatusCyclePattern =

[line 52]

Variable that contains status cycle pattern object



Tags:

access:  public

Type:   object


[ Top ]

$spStatusCyclePatternID =

[line 57]

Variable that contains status cycle pattern ID



Tags:

access:  public

Type:   int


[ Top ]

$spStatusDescription =

[line 67]

Variable that contains status description



Tags:

access:  public

Type:   string


[ Top ]

$spStatusID =

[line 47]

Variable that contains object ID



Tags:

access:  public

Type:   int


[ Top ]

$spStatusName =

[line 62]

Variable that contains status name



Tags:

access:  public

Type:   string


[ Top ]

$table =  "SPstatus"

[line 41]

Variable that contains table name



Tags:

access:  public

Type:   string


[ Top ]


Class Methods

method createSPstatus [line 118]

object created createSPstatus( object $this->spStatusCyclePattern, string $this->spStatusName, string $this->spStatusDescription)

SPstatus object creation function

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

  1.  <?php
  2.  $aVars     = array(
  3.       "spStatusCyclePattern" => $oSPcycleType,
  4.       "spStatusName" => "fooName",
  5.       "spStatusDescription" => "barDescription"
  6.  );
  7.  $oSPstatus = new SPstatus($aVars);
  8.  echo $oSPstatus->createSPstatus()->spStatusID;
  9.  // statusID
  10.  ?>




Tags:

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


Parameters:

object   $this->spStatusCyclePattern   status cycle pattern (required)
string   $this->spStatusName   status name (required)
string   $this->spStatusDescription   status description (required)

[ Top ]

method deleteSPstatus [line 293]

bool deleteSPstatus( int $this->spStatusID)

SPstatus object deletion function

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

  1.  <?php
  2.  $aVars                = array("spStatusID" => 12);
  3.  $oSPstatus            = new SPstatus($aVars);
  4.  echo $oSPstatus->deleteSPstatus();
  5.  // 1
  6.  ?>




Tags:

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


Parameters:

int   $this->spStatusID   ID of the status to be deleted (required)

[ Top ]

method getSPstatus [line 334]

object SPstatus getSPstatus( int $this->spStatusID)

SPstatus object obtention function

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

  1.  <?php
  2.  $aVars                = array("spStatusID" => 12);
  3.  $oSPstatus            = new SPstatus($aVars);
  4.  echo $oSPstatus->getSPstatus()->spStatusName;
  5.  // fooName
  6.  ?>




Tags:

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


Parameters:

int   $this->spStatusID   ID of the status to get (required)

[ Top ]

method updateSPstatus [line 205]

object updated updateSPstatus( int $this->spStatusID, object $this->spStatusCyclePattern, string $this->spStatusName, string $this->spStatusDescription)

SPstatus object update function

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

  1.  <?php
  2.  $aVars     = array(
  3.       "spStatusID" => 12,
  4.       "spStatusCyclePattern" => $oCyclePattern,
  5.       "spStatusName" => "fooName",
  6.       "spStatusDescription" => "barDescription"
  7.  );
  8.  $oSPstatus = new SPstatus($aVars);
  9.  echo $oSPstatus->updateSPstatus()->spStatusID;
  10.  // 12
  11.  ?>




Tags:

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


Parameters:

int   $this->spStatusID   ID of the status to be updated (required)
object   $this->spStatusCyclePattern   cycle pattern of the status (required)
string   $this->spStatusName   status name (required)
string   $this->spStatusDescription   status description (required)

[ Top ]

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