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

Class: WBcollection

Source Location: /WBcollection.php

Class Overview

WBobject
   |
   --WBcollection

This class manages WBcollection. This is a main definition for collection of objects.


Author(s):

Version:

  • 1.6

Variables

Methods


Child classes:

GEOcities
This class manages GEOcity objects collection.
GEOcountries
This class manages GEOcountry objects collection.
SOheaders
This class manages SOheader objects collection.
SOstatuses
This class manages SOstatuses objects.
SOtypes
This class manages SOtypes.
SPcycles
This class manages SPcycle objects collection.
SPcycleTypes
This class manages SPcycleType objects collection.
SPitems
This class manages SPitem objects collection.
SPitemSets
This class manages SPitemSet objects collection.
SPitemTypes
This class manages SPitemType objects collection.
SPsetups
This class manages SPsetup objects collection.
SPstatuses
This class manages SPstatus objects collection.
TSbuckets
This class manages TSbucket objects collection.
TSbucketSets
This class manages TSbucketSet objects collection.
TShorizons
This class manages TShorizon objects collection.
TShorizonTypes
This class manages TShorizonType objects collection.
TSperiodMatches
This class manages TSperiodMatch objects collection.
TSperiods
This class manages TSperiod objects collection.
TSperiodTypes
This class manages TSperiodType objects collection.
WBactivityLogs
This class manages WBactivityLog objects list.
WBapplications
This class manages WBapplication objects collection.
WBcompanies
This class manages WBcompany objects collection.
WBcountries
This class manages WBcountry objects collection. These objects are geographical countries list.
WBcurrencies
This class manages WBcurrency objects collection.
WBmarkets
This class manages WBmarket objects collection.
WBproductItems
This class manages WBproductItem objects collection.
WBproductModels
This class manages WBproductModel objects collection.
WBproductRanges
This class manages WBproductRange objects collection.
WBprofiledUsers
This class manages WBprofiledUser objects collection.
WBprofiledUserSettings
This class manages WBprofiledUserSetting objects collection.
WBprofiles
This class manages WBprofile objects collection.
WBregions
This class manages WBregion objects collections.
WBreportFamilies
This class manages WBreportFamily objects collection.
WBreports
This class manages WBreport objects collection.
WBsubZones
This class manages WBsubZone objects collection.
WBusers
This class manages WBuser objects collection.
WBzones
This class manages WBzone objects collections.

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 40]
This class manages WBcollection. This is a main definition for collection of objects.

Created on 02 jul 09

Changes: 1.5 -> 1.6: 13 aug 09 updated: renderHTMLresults() function, no result availability 1.4 -> 1.5: 12 aug 09 updated: renderHTMLresults() comments function added: renderHTMLselect() function 1.3 -> 1.4: 29 jul 09 updated: PEAR annotations modifications renderHTMLresults() function, passed parameters for onclick trigger is now an array 1.2 -> 1.3: 27 jul 09 updated: Arrays() class renamed to CMNarrays() 1.1 -> 1.2: 20 jul 09 added: renderHTMLresults() function 1.0 -> 1.1: 09 jul 09 updated: file is PEAR compatible




Tags:

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


[ Top ]


Class Variables

$_result =

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method getFromDB [line 74]

object fetched getFromDB( string $sMainObjectname, [array $aSearchValues = null], [string $sOrderRow = null], [string $sOrder = "ASC"])

Rows obtention function

This function is used to get multiple rows by specific query of a specified object. Result is returned

  1.  <?php
  2.  $oObjects            new WBobjects();
  3.  print_r($oObjects->getFromDB("fooObject"array(array("fooRow""LIKE",
  4.      "bar%"))"fooRow""DESC")->getResults());
  5.  ?>




Tags:

return:  object
since:  Version 1.0
access:  protected
usedby:  WBcurrencies::getWBcurrencies()
usedby:  WBmarkets::getWBmarkets()
usedby:  WBcountries::getWBcountries()
usedby:  WBproductItems::getWBproductItems()
usedby:  WBapplications::getWBapplications()
usedby:  TSperiodTypes::getTSperiodTypes()
usedby:  WBactivityLogs::getWBactivityLogs()
usedby:  WBproductModels::getWBproductModels()
usedby:  WBcompanies::getWBcompanies()
usedby:  WBprofiledUsers::getWBprofiledUsers()
usedby:  WBreports::getWBreports()
usedby:  WBsubZones::getWBsubZones()
usedby:  WBusers::getWBusers()
usedby:  WBzones::getWBzones()
usedby:  WBreportFamilies::getWBreportFamilies()
usedby:  WBregions::getWBregions()
usedby:  TSperiods::getTSperiods()
usedby:  WBprofiledUserSettings::getWBprofiledUserSettings()
usedby:  WBprofiles::getWBprofiles()
usedby:  WBproductRanges::getWBproductRanges()
usedby:  TShorizonTypes::getTShorizonTypes()
usedby:  SOheaders::getSOheaders()
usedby:  SOstatuses::getSOstatuses()
usedby:  SOtypes::getSOtypes()
usedby:  GEOcountries::getGEOcountries()
usedby:  GEOcities::getGEOcities()
uses:  MySQL::SelectRow()
uses:  WBobject::getIDrowname()
uses:  WBobject::getObjects()
usedby:  SPcycles::getSPcycles()
usedby:  SPcycleTypes::getSPcycleTypes()
usedby:  TSbuckets::getTSbuckets()
usedby:  TSbucketSets::getTSbucketSets()
usedby:  TShorizons::getTShorizons()
usedby:  SPstatuses::getSPstatuses()
usedby:  SPsetups::getSPsetups()
usedby:  SPitems::getSPitems()
usedby:  SPitemSets::getSPitemSets()
usedby:  SPitemTypes::getSPitemTypes()
usedby:  TSperiodMatches::getTSperiodMatches()


Parameters:

string   $sMainObjectname   database name (required)
array   $aSearchValues   search values: array( array("fooRow", "="|"LIKE", "barValue"), array(), ...)
string   $sOrderRow   name of the row to be used to order
string   $sOrder   ASC or DESC

[ Top ]

method getResults [line 202]

array getResults( )

Results obtention function

This function is used to return the obtained results Result is returned

  1.  <?php
  2.  $oObjects            new WBobjects();
  3.  print_r($oObjects->getFromDB("fooObject"array(array("fooRow""LIKE",
  4.      "bar%"))"fooRow""DESC")->getResults());
  5.  ?>




Tags:

return:  fetched object
since:  Version 1.0


[ Top ]

method renderHTMLresults [line 266]

string renderHTMLresults( array $aSource, [array $aToShow = "*"], [array $aTitles = array()], [string $sActionFunction = null], [array $aActionValues = null])

Results conversion to HTML table function

This function is used to return an HTML table from the obtained results Result is returned

  1.  <?php
  2.  $aToTable       $oCollection->objectToArray(
  3.       $oSubzones->getResults()
  4.  );
  5.  $aToShow   array(
  6.       "rowToShow1",
  7.       "rowToShow2"
  8.  );
  9.  $aTitles   array(
  10.       "row1Name",
  11.       "row2Name"
  12.  );
  13.  echo $oCollection->renderHTMLresults(
  14.       $aToTable,
  15.       $aToShow,
  16.       $aTitles,
  17.       "actionJSfunction",
  18.       array(
  19.           "'JSfunctionpar1'",
  20.           "JSfunctionpar2"
  21.       )
  22.  );
  23.  // renderedhtmltable
  24.  ?>




Tags:

return:  html table string
since:  version 1.2
uses:  HTMLtables::HTMLTableConstruct()
uses:  CMNarrays::flattenArray()


Parameters:

array   $aSource   array to be converted (required)
array   $aToShow   array of the rows to be showned
array   $aTitles   array of titles of the rows to be showned
string   $sActionFunction   javascript to be launched on a TR line
array   $aActionValues   parameters to be passed to the javascript function

[ Top ]

method renderHTMLselect [line 401]

array renderHTMLselect( $sName, [ $sValueRow = null], [ $sLabelRow = null], [ $sIDName = null], [ $sSelected = null], string $sOrderRow)

Results obtention function

This function is used to return the obtained results Result is returned

  1.  <?php
  2.  $oObjects            new WBobjects();
  3.  print_r($oObjects->getFromDB("fooObject"array(array("fooRow""LIKE",
  4.      "bar%"))"fooRow""DESC")->getResults());
  5.  ?>




Tags:

return:  fetched object
since:  version 1.5
uses:  WBobject::getIDrowname()
uses:  HTMLselects::HTMLSelectConstruct()


Parameters:

string   $sOrderRow   name of the row to be used to order
   $sName  
   $sValueRow  
   $sLabelRow  
   $sIDName  
   $sSelected  

[ Top ]


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