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


Files:
TSbucket.php
TSbuckets.php
TSbucketSet.php
TSbucketSets.php
TShorizon.php
TShorizons.php
TShorizonType.php
TShorizonTypes.php
TSperiod.php
TSperiodMatch.php
TSperiodMatches.php
TSperiods.php
TSperiodType.php
TSperiodTypes.php

Classes:
TSbucket
TSbuckets
TSbucketSet
TSbucketSets
TShorizon
TShorizons
TShorizonType
TShorizonTypes
TSperiod
TSperiodMatch
TSperiodMatches
TSperiods
TSperiodType
TSperiodTypes

Class: TShorizon

Source Location: /TShorizon.php

Class Overview

WBobject
   |
   --TShorizon

This class manages TShorizon objects. Collection of horizons available with links to periods.


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 TShorizon objects. Collection of horizons available with links to periods.

Created on 07 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(
        "tsHorizonPattern"  =>  "TShorizonType"
    )

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

[line 73]

Variable that contains ID rowname



Tags:

access:  protected

Type:   string


[ Top ]

$table =  "TShorizon"

[line 41]

Variable that contains table name



Tags:

access:  public

Type:   string


[ Top ]

$tsHorizonCode =

[line 52]

Variable that contains code of the horizon



Tags:

access:  public

Type:   string


[ Top ]

$tsHorizonID =

[line 47]

Variable that contains object ID



Tags:

access:  public

Type:   int


[ Top ]

$tsHorizonLength =

[line 67]

Variable that contains horizon length



Tags:

access:  public

Type:   number


[ Top ]

$tsHorizonPattern =

[line 57]

Variable that contains pattern of the horizon (object)



Tags:

access:  public

Type:   object


[ Top ]

$tsHorizonPatternID =

[line 62]

Variable that contains pattern of the horizon (ID)



Tags:

access:  public

Type:   int


[ Top ]


Class Methods

method createTShorizon [line 118]

object created createTShorizon( string $this->tsHorizonCode, object $this->tsHorizonPattern, int $this->tsHorizonLength)

TShorizon object creation function

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

  1.  <?php
  2.  $aVars      = array("tsHorizonCode" => "fooCode",
  3.       "tsHorizonPattern" => $oTShorizonType,
  4.       "tsHorizonLength" => 12);
  5.  $oTShorizon = new TShorizon($aVars);
  6.  echo $oTShorizon->createTShorizon()->tsHorizonID;
  7.  // horizonID
  8.  ?>




Tags:

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


Parameters:

string   $this->tsHorizonCode   code of the horizon (required)
object   $this->tsHorizonPattern   pattern of the horizon (required)
int   $this->tsHorizonLength   length of the horizon (required)

[ Top ]

method deleteTShorizon [line 288]

bool deleteTShorizon( int $this->tsHorizonID)

TShorizon object deletion function

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

  1.  <?php
  2.  $aVars                = array("tsHorizonID"=>12);
  3.  $oTShorizon           = new TShorizon($aVars);
  4.  echo $oTShorizon->deleteTShorizon();
  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->tsHorizonID   ID of the horizon to be deleted (required)

[ Top ]

method getTShorizon [line 330]

object TShorizon getTShorizon( int $this->tsHorizonID)

TShorizon object obtention function

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

  1.  <?php
  2.  $aVars                = array("tsHorizonID" => 12);
  3.  $oTShorizon           = new TShorizon($aVars);
  4.  echo $oTShorizon->getTShorizon()->tsHorizonCode;
  5.  // fooCode
  6.  ?>




Tags:

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


Parameters:

int   $this->tsHorizonID   ID of the horizon to get (required)

[ Top ]

method updateTShorizon [line 201]

object updated updateTShorizon( int $this->tsHorizonID, string $this->tsHorizonCode, object $this->tsHorizonPattern, int $this->tsHorizonLength)

TShorizon object update function

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

  1.  <?php
  2.  $aVars      = array("tsHorizonID" => 12,
  3.       "tsHorizonCode" => "fooCode",
  4.       "tsHorizonPattern" => $oTShorizonType,
  5.       "tsHorizonLength" => 12);
  6.  $oTShorizon = new TShorizon($aVars);
  7.  echo $oTShorizon->updateTShorizon()->tsHorizonID;
  8.  // 12
  9.  ?>




Tags:

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


Parameters:

int   $this->tsHorizonID   ID of the horizon to be updated (required)
string   $this->tsHorizonCode   code of the horizon (required)
object   $this->tsHorizonPattern   pattern of the horizon (required)
int   $this->tsHorizonLength   length of the horizon (required)

[ Top ]

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