| applications_smartshop

# Class: Bs_Ss_XProduct Source Location: /applications/smartshop/Bs_Ss_XProduct.class.php
### Class Overview
    Bs_Object
       |
       --Bs_Ss_XAtom
          |
          --Bs_Ss_XProduct
SmartShop XBlock Class #### Author(s): andrej arn <at blueshoes dot org>, Sam Blum <sam at blueshoes dot org> #### Version: 4.3.$Revision: 1.4 $ $Date: 2003/08/09 15:22:35 $ #### Copyright: blueshoes.org | ### Variables $_dataContainer $_emptyImageProp $_emptyPriceProp $_emptySeealsoProp $_fileFullPath | ### Methods Bs_Ss_XProduct dirtyFormatting dirtyFormattingOfDiversity getCaption getCaptionAdd getCurrency getDescription getDescriptionAdd getFormatted getFullCaption getImageFormatted getLanguageVar getOrdercode getOrdercodes getPrice hasDiversity init
### Inherited Variables #### Class: Bs_Ss_XAtom Bs_Ss_XAtom::$fullTrace Bs_Ss_XAtom::$_APP Bs_Ss_XAtom::$_atomContainer Bs_Ss_XAtom::$_failedReason 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 17] SmartShop XBlock Class #### 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>, Sam Blum <sam at blueshoes dot org>
[ Top ] ### Class Variables #### $_dataContainer = array() [line 35]
Type: | mixed
[ Top ] #### $_emptyImageProp = array( 'src' => '', 'width' => NULL, 'height' => NULL, 'alt' => NULL ) [line 57]
Type: | mixed
[ Top ] #### $_emptyPriceProp = array( 'value' => NULL, 'currency' => NULL, 'denomination' => NULL, ) [line 70]
Type: | mixed
[ Top ] #### $_emptySeealsoProp = array( 'type' => NULL, 'UID' => NULL, ) [line 65]
Type: | mixed
[ Top ] #### $_fileFullPath = [line 76]
Type: | mixed
[ Top ] ### Class Methods ### constructor Bs_Ss_XProduct [line 82]
`Bs_Ss_XProduct Bs_Ss_XProduct( mixed &$shop)`
Constructor. [ Top ] ### method dirtyFormatting [line 294]
`string dirtyFormatting( array $design, [int $givenOrderCode = NULL])`
#### Parameters:
array | $design | (hash)
int | $givenOrderCode | (default is NULL which means use diversity also.)
[ Top ] ### method dirtyFormattingOfDiversity [line 367]
`void dirtyFormattingOfDiversity( mixed $design, mixed $diversityOrderCode)`
[ Top ] ### method getCaption [line 172]
`double getCaption( [string $orderCode = NULL], [bool $fallBack = TRUE])`
returns the caption for the given orderCode. #### Tags:
throws: | bool FALSE (if not set)
access: | public
#### Parameters:
string | $orderCode | (if needed)
bool | $fallBack | (uses general value if not set for your ordercode, default is TRUE)
[ Top ] ### method getCaptionAdd [line 175]
`void getCaptionAdd( [mixed $orderCode = NULL], [mixed $fallBack = TRUE])`
[ Top ] ### method getCurrency [line 160]
`void getCurrency( [mixed $orderCode = NULL], [mixed $fallBack = TRUE])`
[ Top ] ### method getDescription [line 195]
`void getDescription( [mixed $orderCode = NULL], [mixed $fallBack = TRUE])`
[ Top ] ### method getDescriptionAdd [line 198]
`void getDescriptionAdd( [mixed $orderCode = NULL], [mixed $fallBack = TRUE])`
[ Top ] ### method getFormatted [line 439]
`void getFormatted( mixed $format)`
[ Top ] ### method getFullCaption [line 185]
`void getFullCaption( [string $orderCode = NULL], [bool $fallBack = TRUE])`
returns the full caption (caption + captionadd) for the orderCode specified. #### Tags:
see: | getCaption() and getCaptionAdd()
access: | public
#### Parameters:
string | $orderCode | (if needed)
bool | $fallBack | (uses general value if not set for your ordercode, default is TRUE)
[ Top ] ### method getImageFormatted [line 274]
`string getImageFormatted( mixed $imgName)`
returns the image tag for the given image. #### Tags:
throws: | bool FALSE
access: | public
[ Top ] ### method getLanguageVar [line 263]
`the getLanguageVar( mixed $varName)`
#### Tags:
return: | language var for the language that's in use.
throws: | bool FALSE
access: | public
[ Top ] ### method getOrdercode [line 202]
`void getOrdercode( [mixed $orderCode = NULL], [mixed $fallBack = TRUE])`
[ Top ] ### method getOrdercodes [line 131]
`array getOrdercodes( )`
returns a list of all available ordercodes (diversity) for that product. #### Tags:
return: | (vector)
access: | public
[ Top ] ### method getPrice [line 156]
`double getPrice( [string $orderCode = NULL], [bool $fallBack = TRUE])`
returns the price for the given orderCode. #### Tags:
throws: | bool FALSE (if not set)
access: | public
#### Parameters:
string | $orderCode | (if needed)
bool | $fallBack | (uses general value if not set for your ordercode, default is TRUE)
[ Top ] ### method hasDiversity [line 121]
`bool hasDiversity( )`
tells if this product is a simple product or if it has different order options (like different colors, sizes or such). #### Tags:
access: | public
[ Top ] ### method init [line 101]
`bool init( mixed $UID, string $blockUbi)`
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 | $blockUbi | (see above)
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:12:54 +0100 by phpDocumentor 1.2.3