| applications_smartshop

# Class: Bs_Ss_XCategory Source Location: /applications/smartshop/Bs_Ss_XCategory.class.php
### Class Overview
    Bs_Object
       |
       --Bs_Ss_XAtom
          |
          --Bs_Ss_XCategory
SmartShop XCategory Class #### Author(s): andrej arn <at blueshoes dot org> #### Version: 4.3.$Revision: 1.3 $ $Date: 2003/08/09 15:22:35 $ #### Copyright: blueshoes.org | ### Variables $_dataContainer $_dataPath $_productsLoaded | ### Methods Bs_Ss_XCategory getBasketLine getDesign getFailedReason getFormatted init loadProducts _parseFormattedLine
### Inherited Variables #### Class: Bs_Ss_XAtom Bs_Ss_XAtom::$fullTrace Bs_Ss_XAtom::$_APP Bs_Ss_XAtom::$_atomContainer Bs_Ss_XAtom::$_tempContainer Bs_Ss_XAtom::$_traceMsg Bs_Ss_XAtom::$_xClearingHouse Bs_Ss_XAtom::$_xStorage | ### 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 33] SmartShop XCategory Class dependencies: Bs_Dir, Bs_Ss_XAtom, XPath #### Tags:
copyright: | blueshoes.org
pattern: | singleton: (pseudostatic)
access: | public
version: | 4.3.$Revision: 1.3 $ $Date: 2003/08/09 15:22:35 $
author: | andrej arn <at blueshoes dot org>
[ Top ] ### Class Variables #### $_dataContainer = array( 'parentId' => NULL, 'orderId' => NULL, 'language' => array( ),) [line 51]
Type: | mixed
[ Top ] #### $_dataPath = [line 59]
Type: | mixed
[ Top ] #### $_productsLoaded = FALSE [line 73] tells if the products have been loaded.
Type: | mixed
[ Top ] ### Class Methods ### constructor Bs_Ss_XCategory [line 89]
`Bs_Ss_XCategory Bs_Ss_XCategory( mixed &$shop)`
Constructor. [ Top ] ### method getBasketLine [line 254]
`void getBasketLine( )`
[ Top ] ### method getDesign [line 260]
`void getDesign( mixed $format)`
[ Top ] ### method getFailedReason [line 334]
`void getFailedReason( )`
#### Tags:
see: | var $_failedReason
Overrides Bs_Ss_XAtom::getFailedReason() (Tells what went wrong.) [ Top ] ### method getFormatted [line 273]
`string getFormatted( [string $format = 'overview'], [bool $onlyActive = TRUE])`
returns the category listing in a formatted way. #### Tags:
throws: | bool FALSE (see getFailedReason())
access: | public
#### Parameters:
string | $format | (default is 'overview')
bool | $onlyActive | (default is TRUE. uses only products that are active right now.)
[ Top ] ### method init [line 107]
`bool init( string $UID)`
Init this object using an UID it's either numeric (ID of Db) or a string set together of UNI (Unified Node ID) + core name (source name without version and extentions) 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 | $UID | (see above)
[ Top ] ### method loadProducts [line 125]
`bool loadProducts( [bool $force = FALSE])`
loads all products that belong to this category and sets $this->_products. #### Tags:
access: | public
#### Parameters:
bool | $force | (forces to reload even if loaded already. default is FALSE.)
[ Top ] ### method _parseFormattedLine [line 187]
`string _parseFormattedLine( object $xPath, object $prodObj)`
allowed tags: <bs:image name="overview"/> <bs:language name="caption"/> <bs:price/> <bs:basket/> __UID__ __ORDERCODE__ #### Parameters:
object | $xPath |
object | $prodObj |
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:12:52 +0100 by phpDocumentor 1.2.3