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


Files:
SOheader.php
SOheaders.php
SOstatus.php
SOstatuses.php
SOtype.php
SOtypes.php

Classes:
SOheader
SOheaders
SOstatus
SOstatuses
SOtype
SOtypes

Class: SOheader

Source Location: /SOheader.php

Class Overview

WBobject
   |
   --SOheader

This class manages SOheader objects. General information of a supply order.


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 SOheader objects. General information of a supply order.

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("soHeaderType" => "SOtype", 
        "soStatus" => "SOstatus")

[line 133]

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

[line 128]

Variable that contains ID rowname



Tags:

access:  protected

Type:   string


[ Top ]

$soArrivalComments =

[line 117]

Variable that contains arrival comments



Tags:

access:  public

Type:   string


[ Top ]

$soArrivalDateTS =

[line 107]

Variable that contains arrival date (timestamp)



Tags:

access:  public

Type:   int


[ Top ]

$soCreditNumber =

[line 77]

Variable that contains credit number



Tags:

access:  public

Type:   string


[ Top ]

$soCustomerOrder =

[line 62]

Variable that contains customer order



Tags:

access:  public

Type:   string


[ Top ]

$soDespatchDateTS =

[line 92]

Variable that contains despatch date (timestamp)



Tags:

access:  public

Type:   int


[ Top ]

$soETAdateTS =

[line 102]

Variable that contains ETA date (timestamp)



Tags:

access:  public

Type:   int


[ Top ]

$soETDdateTS =

[line 97]

Variable that contains ETD date (timestamp)



Tags:

access:  public

Type:   int


[ Top ]

$soHeaderID =

[line 47]

Variable that contains object ID



Tags:

access:  public

Type:   int


[ Top ]

$soHeaderType =

[line 52]

Variable that contains header type object



Tags:

access:  public

Type:   object


[ Top ]

$soHeaderTypeID =

[line 57]

Variable that contains header type ID



Tags:

access:  public

Type:   int


[ Top ]

$soNumberOrder =

[line 72]

Variable that contains number order



Tags:

access:  public

Type:   string


[ Top ]

$soStatus =

[line 82]

Variable that contains status object



Tags:

access:  public

Type:   object


[ Top ]

$soStatusID =

[line 87]

Variable that contains status ID



Tags:

access:  public

Type:   int


[ Top ]

$soSupplierOrder =

[line 67]

Variable that contains supplier order



Tags:

access:  public

Type:   string


[ Top ]

$soUploadedTS =

[line 122]

Variable that contains uploaded date



Tags:

access:  public

Type:   int


[ Top ]

$soVesselName =

[line 112]

Variable that contains vessel name



Tags:

access:  public

Type:   string


[ Top ]

$table =  "SOheader"

[line 41]

Variable that contains table name



Tags:

access:  public

Type:   string


[ Top ]


Class Methods

method createSOheader [line 183]

object created createSOheader( object $this->soHeaderType, string $this->soCustomerOrder, string $this->soSupplierOrder, string $this->soNumberOrder, string $this->soCreditNumber, string $this->soStatus, string $this->soDespatchDateTS, string $this->soETDdateTS, string $this->soETAdateTS, string $this->soArrivalDateTS, string $this->soVesselName, string $this->soArrivalComments, string $this->soUploadedTS)

SOheader object creation function

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

  1.  <?php
  2.  $aVars      = array("soHeaderType" => $oSOtype,
  3.      "soCustomerOrder" => "fooOrder", "soSupplierOrder" => "barOrder",
  4.      "soNumberOrder" => "fooOrder", "soCreditNumber" => "barNumber",
  5.      "soStatus" => $oSOstatus, "soDespatchDateTS" => 1234567890,
  6.      "soETDdateTS" => 1234567809, "soETAdateTS" => 1234567890,
  7.      "soArrivalDateTS" => 1234567890, "soVesselName" => "fooName",
  8.      "soArrivalComments" => "barComments", "soUploadedTS" => 1234567890);
  9.  $oSOheader  = new SOheader($aVars);
  10.  echo $oSOheader->createSOheader()->soHeaderID;
  11.  // headerID
  12.  ?>




Tags:

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


Parameters:

object   $this->soHeaderType   type of the document (required)
string   $this->soCustomerOrder   customer order (required)
string   $this->soSupplierOrder   supplier order (required)
string   $this->soNumberOrder   number order (required)
string   $this->soCreditNumber   credit number (required)
string   $this->soStatus   status (required)
string   $this->soDespatchDateTS   despatch date (required)
string   $this->soETDdateTS   ETD date (required)
string   $this->soETAdateTS   ETA date (required)
string   $this->soArrivalDateTS   arrival date (required)
string   $this->soVesselName   vessel name (required)
string   $this->soArrivalComments   arrival comments
string   $this->soUploadedTS   uploaded date (required)

[ Top ]

method deleteSOheader [line 565]

bool deleteSOheader( int $this->soHeaderID)

SOheader object deletion function

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

  1.  <?php
  2.  $aVars                = array("soHeaderID" => 12);
  3.  $oSOheader            = new SOheader($aVars);
  4.  echo $oSOheader->deleteSOheader();
  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->soHeaderID   ID of the header to be deleted (required)

[ Top ]

method getSOheader [line 606]

object SOheader getSOheader( int $this->soHeaderID)

SOheader object obtention function

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

  1.  <?php
  2.  $aVars                = array("soHeaderID" => 12);
  3.  $oSOheader            = new SOheader($aVars);
  4.  echo $oSOheader->getSOheader()->soStatus->soStatusName;
  5.  // fooName
  6.  ?>




Tags:

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


Parameters:

int   $this->soHeaderID   ID of the header to get (required)

[ Top ]

method updateSOheader [line 381]

object updated updateSOheader( int $this->soHeaderID, object $this->soHeaderType, string $this->soCustomerOrder, string $this->soSupplierOrder, string $this->soNumberOrder, string $this->soCreditNumber, string $this->soStatus, string $this->soDespatchDateTS, string $this->soETDdateTS, string $this->soETAdateTS, string $this->soArrivalDateTS, string $this->soVesselName, string $this->soArrivalComments, string $this->soUploadedTS)

SOheader object update function

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

  1.  <?php
  2.  $aVars     = array("soHeaderID" => 12, "soHeaderType" => $oSOtype,
  3.      "soCustomerOrder" => "fooOrder", "soSupplierOrder" => "barOrder",
  4.      "soNumberOrder" => "fooOrder", "soCreditNumber" => "barNumber",
  5.      "soStatus" => $oSOstatus, "soDespatchDateTS" => 1234567890,
  6.      "soETDdateTS" => 1234567809, "soETAdateTS" => 1234567890,
  7.      "soArrivalDateTS" => 1234567890, "soVesselName" => "fooName",
  8.      "soArrivalComments" => "barComments", "soUploadedTS" => 1234567890);
  9.  $oSOheader = new SOheader($aVars);
  10.  echo $oSOheader->updateSOheader()->soHeaderID;
  11.  // 12
  12.  ?>




Tags:

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


Parameters:

int   $this->soHeaderID   ID of the header to be updated (required)
object   $this->soHeaderType   type of the document (required)
string   $this->soCustomerOrder   customer order (required)
string   $this->soSupplierOrder   supplier order (required)
string   $this->soNumberOrder   number order (required)
string   $this->soCreditNumber   credit number (required)
string   $this->soStatus   status (required)
string   $this->soDespatchDateTS   despatch date (required)
string   $this->soETDdateTS   ETD date (required)
string   $this->soETAdateTS   ETA date (required)
string   $this->soArrivalDateTS   arrival date (required)
string   $this->soVesselName   vessel name (required)
string   $this->soArrivalComments   arrival comments
string   $this->soUploadedTS   uploaded date (required)

[ Top ]

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