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


Files:
Link_WBcurrency_WBcountry.php
Link_WBmarket_WBcountry.php
Link_WBprofiledUser_WBmarket.php
WBactivityLog.php
WBactivityLogs.php
WBapplication.php
WBapplications.php
WBcollection.php
WBcompanies.php
WBcompany.php
WBcountries.php
WBcountry.php
WBcurrencies.php
WBcurrency.php
WBmarket.php
WBmarkets.php
WBobject.php
WBproductItem.php
WBproductItems.php
WBproductModel.php
WBproductModels.php
WBproductRange.php
WBproductRanges.php
WBprofile.php
WBprofiledUser.php
WBprofiledUsers.php
WBprofiledUserSetting.php
WBprofiledUserSettings.php
WBprofiles.php
WBregion.php
WBregions.php
WBreport.php
WBreportFamilies.php
WBreportFamily.php
WBreports.php
WBsubZone.php
WBsubZones.php
WBuser.php
WBusers.php
WBview.php
WBzone.php
WBzones.php

Classes:
Link_WBcurrency_WBcountry
Link_WBmarket_WBcountry
Link_WBprofiledUser_WBmarket
WBactivityLog
WBactivityLogs
WBapplication
WBapplications
WBcollection
WBcompanies
WBcompany
WBcountries
WBcountry
WBcurrencies
WBcurrency
WBmarket
WBmarkets
WBobject
WBproductItem
WBproductItems
WBproductModel
WBproductModels
WBproductRange
WBproductRanges
WBprofile
WBprofiledUser
WBprofiledUsers
WBprofiledUserSetting
WBprofiledUserSettings
WBprofiles
WBregion
WBregions
WBreport
WBreportFamilies
WBreportFamily
WBreports
WBsubZone
WBsubZones
WBuser
WBusers
WBview
WBzone
WBzones

Class: WBsubZone

Source Location: /WBsubZone.php

Class Overview

WBobject
   |
   --WBsubZone

This class manages WBsubZone objects. Group of regions.


Author(s):

Version:

  • 1.2

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 WBsubZone objects. Group of regions.

Created on 30 jun 09

Changes: 1.1 -> 1.2: 14 jul 09 updated: file is PEAR compatible 1.0 -> 1.1: 02 jul 09 added: $this->sIDrowname, $this->aObjects




Tags:

author:  Pierre-Dominique Vienne <pvienne@me.com>
version:  1.2
license:  GNU Public License


[ Top ]

Class Variables

$aObjects = array(
        "wbSubZoneZone" => "WBzone")

[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 =  "wbSubZoneID"

[line 69]

Variable that contains ID rowname



Tags:

access:  protected

Type:   string


[ Top ]

$table =  "WBsubZone"

[line 42]

Variable that contains table name



Tags:

access:  public

Type:   string


[ Top ]

$wbSubZoneID =

[line 48]

Variable that contains object ID



Tags:

access:  public

Type:   int


[ Top ]

$wbSubZoneName =

[line 53]

Variable that contains subzone name



Tags:

access:  public

Type:   string


[ Top ]

$wbSubZoneZone =

[line 58]

Variable that contains zone object



Tags:

access:  public

Type:   object


[ Top ]

$wbSubZoneZoneID =

[line 63]

Variable that contains zone ID



Tags:

access:  public

Type:   int


[ Top ]


Class Methods

method createWBsubZone [line 108]

object created createWBsubZone( string $this->wbSubZoneName, object $this->wbSubZoneZone)

WBsubZone object creation function

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

  1.  <?php
  2.  $aVars      = array("wbSubZoneName" => "fooName",
  3.       "wbSubZoneZone" => $oWBzone);
  4.  $oWBsubZone = new WBsubZone($aVars);
  5.  echo $oWBsubZone->createWBsubZone()->wbSubZoneID;
  6.  // zoneID
  7.  ?>




Tags:

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


Parameters:

string   $this->wbSubZoneName   name of the subzone (required)
object   $this->wbSubZoneZone   zone of the subzone (required)

[ Top ]

method deleteWBsubZone [line 252]

bool deleteWBsubZone( int $this->wbSubZoneID)

WBsubZone object deletion function

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

  1.  <?php
  2.  $aVars      = array("wbSubZoneID" => 12);
  3.  $oWBsubZone = new WBsubZone($aVars);
  4.  echo $oWBsubZone->deleteWBsubZone();
  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->wbSubZoneID   ID of the subzone to be deleted (required)

[ Top ]

method getWBsubZone [line 294]

object WBsubZone getWBsubZone( int $this->wbSubZoneID)

WBsubZone object obtention function

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

  1.  <?php
  2.  $aVars       = array("wbSubZoneID" => 12);
  3.  $oWBsubZone  = new WBsubZone($aVars);
  4.  echo $oWBsubZone->getWBsubZone()->wbSubZoneName;
  5.  // fooName
  6.  ?>




Tags:

return:  object
since:  Version 1.0
usedby:  WBregion::getWBregion()
uses:  WBobject::getUniqueFromDB()
uses:  WBzone::getWBzone()


Parameters:

int   $this->wbSubZoneID   ID of the subzone to get (required)

[ Top ]

method updateWBsubZone [line 174]

object updated updateWBsubZone( int $this->wbSubZoneID, string $this->wbSubZoneName, object $this->wbSubZoneZone)

WBsubZone object update function

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

  1.  <?php
  2.  $aVars      = array("wbSubZoneID" => 12, "wbSubZoneName" => "fooName",
  3.       "wbSubZoneZone" => $oWBzone);
  4.  $oWBsubZone = new WBsubZone($aVars);
  5.  echo $oWBsubZone->updateWBsubZone()->wbSubZoneID;
  6.  // 12
  7.  ?>




Tags:

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


Parameters:

int   $this->wbSubZoneID   ID of the subzone to be updated (required)
string   $this->wbSubZoneName   name of the subzone (required)
object   $this->wbSubZoneZone   zone of the subzone (required)

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:31:14 +0200 by phpDocumentor 1.4.1