blueshoes php application framework and cms            applications_smartshop
[ class tree: applications_smartshop ] [ index: applications_smartshop ] [ all elements ]

Class: Bs_Ss_SmartShop

Source Location: /applications/smartshop/Bs_Ss_SmartShop.class.php

Class Overview

Bs_Object
   |
   --Bs_Ss_XAtom
      |
      --Bs_Ss_SmartShop

SmartShop Class


Author(s):

Version:

  • 4.3.$Revision: 1.4 $ $Date: 2003/08/09 15:22:35 $

Copyright:

  • blueshoes.org

Variables

Methods


Inherited Variables

Inherited Methods

Class: Bs_Ss_XAtom

Bs_Ss_XAtom::Bs_Ss_XAtom()
Constructor.
Bs_Ss_XAtom::datetimeInRange()
Tells if this element is ALIVE.
Bs_Ss_XAtom::getFailedReason()
Tells what went wrong.
Bs_Ss_XAtom::getUid()
Bs_Ss_XAtom::init()
Init this object using the UID (Unified ID) The UID is either numeric (ID of Db) or a string
Bs_Ss_XAtom::isAlive()
Tells if something (page, node, block, whatever) with the given properties is alive or not.
Bs_Ss_XAtom::persist()
Use the XStorage to persist any XAtom
Bs_Ss_XAtom::reset()
Reset the whole object
Bs_Ss_XAtom::toXml()
Generate a XML output of the element (XCategory, XProduct)

Class: Bs_Object

Bs_Object::Bs_Object()
Bs_Object::getErrors()
Basic error handling: Get *all* errors as string array from the global Bs_Error-error stack.
Bs_Object::getLastError()
Basic error handling: Get last error string from the global Bs_Error-error stack.
Bs_Object::getLastErrors()
Basic error handling: Get last errors string array from the global Bs_Error-error stack sinc last call of getLastErrors().
Bs_Object::persist()
Persists this object by serializing it and saving it to a file with unique name.
Bs_Object::setError()
Basic error handling: Push an error string on the global Bs_Error-error stack.
Bs_Object::toHtml()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::toString()
Dumps the content of this object to a string using PHP's var_dump().
Bs_Object::unpersist()
Fetches an object that was persisted with persist()

Class Details

[line 66]
SmartShop Class

dependencies: Bs_Ss_XClearingHouse, Bs_XAtom




Tags:

copyright:  blueshoes.org
pattern:  singleton: (pseudostatic)
access:  public
version:  4.3.$Revision: 1.4 $ $Date: 2003/08/09 15:22:35 $
author:  andrej arn <at blueshoes dot org>


[ Top ]


Class Variables

$clearingHouse =

[line 74]

reference to the clearing house object



Tags:

access:  public

Type:   object


[ Top ]

$language =  'en'

[line 143]

the language used for the shop.

default is 'en'.




Tags:

access:  public

Type:   string


[ Top ]

$settings =

[line 154]

settings we got from the APP array.

see $APP['plugins']['your-app-name']['settings'] they currently are: 'cache', 'dataDir', 'templateDir', 'sessionDir'




Tags:

access:  public

Type:   array


[ Top ]

$_dataContainer = array(
        
    'contact' => array(
      'phone' => NULL, 
      'fax' => NULL, 
      'email' => NULL, 
    ),'delivery'=>array(),'payment'=>array('minAmount'=>0,),)

[line 80]


Type:   mixed


[ Top ]



Class Methods


constructor Bs_Ss_SmartShop [line 166]

Bs_Ss_SmartShop Bs_Ss_SmartShop( )



[ Top ]

method getBasket [line 241]

void getBasket( )



[ Top ]

method getCategories [line 208]

void getCategories( mixed $start, [mixed $sub = 0])



[ Top ]

method getCategory [line 211]

void getCategory( mixed $UID)



[ Top ]

method getCategoryFormatted [line 226]

string getCategoryFormatted( string $UID, [string $format = 'overview'])

returns Bs_Ss_XCategory->getFormatted().



Tags:

throws:  bool FALSE (see getFailedReason);
access:  public


Parameters:

string   $UID  
string   $format   (default is 'overview')

[ Top ]

method getFailedReason [line 339]

void getFailedReason( )



Tags:

see:  var $_failedReason


Overrides Bs_Ss_XAtom::getFailedReason() (Tells what went wrong.)

[ Top ]

method getProductFormatted [line 255]

string getProductFormatted( string $UID, [string $format = NULL])

returns the formatted product detail page.



Tags:

todo:  implement $format support.
throws:  bool FALSE
access:  public


Parameters:

string   $UID  
string   $format  

[ Top ]

method init [line 185]

bool init( mixed $UID, string $filePath)

Init this object



Overrides Bs_Ss_XAtom::init() (Init this object using the UID (Unified ID) The UID is either numeric (ID of Db) or a string)

Parameters:

string   $filePath   (fullpath to .xShop file)

[ Top ]


Documentation generated on Mon, 29 Dec 2003 21:12:50 +0100 by phpDocumentor 1.2.3