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: SPitemSet

Source Location: /SPitemSet.php

Class Overview

WBobject
   |
   --SPitemSet

This class manages SPitemSet objects. It holds all the detailed planning information stored and calculated during the planning exercise for a specific SPitem.


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 32]
This class manages SPitemSet objects. It holds all the detailed planning information stored and calculated during the planning exercise for a specific SPitem.

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(
       "spItemSetItem"      => "SPitem",
       "spItemSetModel"     => "WBproductModel",
       "spItemSetDetails"   => "TSbucketSet",
       "spItemSetUpdater"   => "WBuser")

[line 105]

Variable that contains objects list



Tags:

access:  protected

Type:   array


[ Top ]

$database =  "prysma"

[line 38]

Variable that contains database name



Tags:

access:  public

Type:   string


[ Top ]

$sIDrowname =  "spItemSetID"

[line 100]

Variable that contains ID rowname



Tags:

access:  protected

Type:   string


[ Top ]

$spItemSetDetails =

[line 74]

Variable that contains data container object



Tags:

access:  public

Type:   object


[ Top ]

$spItemSetDetailsID =

[line 79]

Variable that contains data container ID



Tags:

access:  public

Type:   int


[ Top ]

$spItemSetID =

[line 49]

Variable that contains object ID



Tags:

access:  public

Type:   int


[ Top ]

$spItemSetItem =

[line 54]

Variable that contains reference to its corresponding item (object)



Tags:

access:  public

Type:   object


[ Top ]

$spItemSetItemID =

[line 59]

Variable that contains reference to its corresponding item (ID)



Tags:

access:  public

Type:   int


[ Top ]

$spItemSetModel =

[line 64]

Variable that contains referred model object



Tags:

access:  public

Type:   object


[ Top ]

$spItemSetModelID =

[line 69]

Variable that contains referred model ID



Tags:

access:  public

Type:   int


[ Top ]

$spItemSetUpdater =

[line 89]

Variable that contains user who made the update (object)



Tags:

access:  public

Type:   object


[ Top ]

$spItemSetUpdaterID =

[line 94]

Variable that contains user who made the update (ID)



Tags:

access:  public

Type:   int


[ Top ]

$spItemSetUpdateTS =

[line 84]

Variable that contains date of the update



Tags:

access:  public

Type:   int


[ Top ]

$table =  "SPitemSet"

[line 43]

Variable that contains table name



Tags:

access:  public

Type:   string


[ Top ]


Class Methods

method createSPitemSet [line 150]

object created createSPitemSet( object $this->spItemSetItem, object $this->spItemSetModel, object $this->spItemSetDetails, object $this->spItemSetUpdater)

SPitemSet object creation function

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

  1.  <?php
  2.  $aVars      = array(
  3.       "spItemSetItem" => $oSPitem,
  4.       "spItemSetModel" => $oWBproductModel,
  5.       "spItemSetDetails" => $oTSbucketSeries,
  6.       "spItemSetUpdater" => $oWBuser);
  7.  $oSPitemSet = new SPitemSet($aVars);
  8.  echo $oSPitemSet->createSPitemSet()->spItemSetID;
  9.  // itemsetID
  10.  ?>




Tags:

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


Parameters:

object   $this->spItemSetItem   corresponding item (required)
object   $this->spItemSetModel   model this set is referring (required)
object   $this->spItemSetDetails   data container (required)
object   $this->spItemSetUpdater   user that has updated the dataset (required)

[ Top ]

method deleteSPitemSet [line 363]

bool deleteSPitemSet( int $this->spItemSetID)

SPitemSet object deletion function

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

  1.  <?php
  2.  $aVars                = array("spItemSetID" => 12);
  3.  $oSPitemSet           = new SPitemSet($aVars);
  4.  echo $oSPitemSet->deleteSPitemSet();
  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->spItemSetID   ID of the item set to be deleted (required)

[ Top ]

method getSPitemSet [line 405]

object SPitemSet getSPitemSet( int $this->spItemSetID)

SPitemSet object obtention function

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

  1.  <?php
  2.  $aVars                = array("spItemSetID" => 12);
  3.  $oSPitemSet           = new SPitemSet($aVars);
  4.  echo $oSPitemSet->getSPitemSet()->spItemSetUpdater->wbUserName;
  5.  // fooName
  6.  ?>




Tags:

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


Parameters:

int   $this->spItemSetID   ID of the item set to get (required)

[ Top ]

method updateSPitemSet [line 257]

object updated updateSPitemSet( int $this->spItemSetID, object $this->spItemSetItem, object $this->spItemSetModel, object $this->spItemSetDetails, object $this->spItemSetUpdater)

SPitemSet object update function

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

  1.  <?php
  2.  $aVars      = array(
  3.       "spItemSetID" => 12,
  4.       "spItemSetItem" => $oSPitem,
  5.       "spItemSetModel" => $oWBproductModel,
  6.       "spItemSetDetails" => $oTSBucketSet,
  7.       "spItemSetUpdater" => $oWBuser);
  8.  $oSPitemSet = new SPitemSet($aVars);
  9.  echo $oSPitemSet->updateSPitemSet()->spItemSetID;
  10.  // 12
  11.  ?>




Tags:

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


Parameters:

int   $this->spItemSetID   ID of the item set to be updated (required)
object   $this->spItemSetItem   item of the item set (required)
object   $this->spItemSetModel   model of the item set (required)
object   $this->spItemSetDetails   details of the item set (required)
object   $this->spItemSetUpdater   updater of the item set (required)

[ Top ]

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