WorkBench
[ class tree: WorkBench ] [ index: WorkBench ] [ all elements ]

Class: WBapplication

Source Location: /WBapplication.php

Class Overview

WBobject
   |
   --WBapplication

This class manages WBapplication objects. These objects are applications used in EVS.


Author(s):

Version:

  • 1.3

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 33]
This class manages WBapplication objects. These objects are applications used in EVS.

Created on 23 jun 09

Changes: 1.2 -> 1.3: 15 jul 09 updated: file is PEAR compatible 1.1 -> 1.2: 03 jul 09 added: $this->sIDrowname, $this->aObjects 1.0 -> 1.1: 24 jun 09 added: getWBapplication() function




Tags:

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


[ Top ]


Class Variables

$aObjects = array()

[line 66]

Variable that contains objects list



Tags:

access:  protected

Type:   array


[ Top ]

$database =  "prysma"

[line 39]

Variable that contains database name



Tags:

access:  public

Type:   string


[ Top ]

$sIDrowname =  "wbApplicationID"

[line 61]

Variable that contains ID rowname



Tags:

access:  protected

Type:   string


[ Top ]

$table =  "WBapplication"

[line 44]

Variable that contains table name



Tags:

access:  public

Type:   string


[ Top ]

$wbApplicationID =

[line 50]

Variable that contains object ID



Tags:

access:  public

Type:   int


[ Top ]

$wbApplicationName =

[line 55]

Variable that contains application name



Tags:

access:  public

Type:   string


[ Top ]



Class Methods


method createWBapplication [line 98]

object created createWBapplication( string $this->wbApplicationName)

WBapplication object creation function

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

  1.  <?php
  2.  $aVars          array("wbApplicationName" => "FooApplication");
  3.  $oWBapplication new WBapplication($aVars);
  4.  echo $oWBapplication->createWBapplication()->wbApplicationID;
  5.  // applicationID
  6.  ?>




Tags:

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


Parameters:

string   $this->wbApplicationName   name of the application (required)

[ Top ]

method deleteWBapplication [line 212]

bool deleteWBapplication( int $this->wbApplicationID)

WBapplication object deletion function

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

  1.  <?php
  2.  $aVars          array("wbApplicationID" => 12);
  3.  $oWBapplication new WBapplication($aVars);
  4.  echo $oWBapplication->deleteWBapplication();
  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->wbApplicationID   ID of the application to be deleted (required)

[ Top ]

method getWBapplication [line 253]

object WBapplication getWBapplication( int $this->wbApplicationID)

WBapplication object obtention function

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

  1.  <?php
  2.  $aVars            array("wbApplicationID"=>12);
  3.  $oWBapplication    new WBapplication($aVars);
  4.  echo $oWBapplication->getWBapplication()->wbApplicationName;
  5.  // fooName
  6.  ?>




Tags:

return:  object
since:  Version 1.1
usedby:  WBprofile::getWBprofile()
uses:  WBobject::getUniqueFromDB()
usedby:  WBactivityLog::getWBactivityLog()


Parameters:

int   $this->wbApplicationID   ID of the application to get (required)

[ Top ]

method updateWBapplication [line 153]

object updated updateWBapplication( int $this->wbApplicationID, string $this->wbApplicationName)

WBapplication object update function

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

  1.  <?php
  2.  $aVars          array(
  3.       "wbApplicationID" => 12,
  4.       "wbApplicationName" => "fooApplication"
  5.  );
  6.  $oWBapplication new WBapplication($aVars);
  7.  echo $oWBapplication->updateWBapplication()->wbApplicationID;
  8.  // 12
  9.  ?>




Tags:

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


Parameters:

int   $this->wbApplicationID   ID of the application to be updated (required)
string   $this->wbApplicationName   Name of the application (required)

[ Top ]


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