Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

tx_commerce_pibase Class Reference

Inheritance diagram for tx_commerce_pibase:

tx_commerce_pi1 tx_commerce_pi2 tx_commerce_pi3 tx_commerce_pi5 tx_commerce_pi6 List of all members.

Public Member Functions

 init ($conf)
 addAdditionalLocallang ()
 generateLanguageMarker ()
 renderProductAttributeList ($prodObj, $subpartNameArray=array(), $TS=false)
 renderArticleAttributeList (&$prodObj, $articleId=array(), $subpartNameArray=array())
 makeListView ()
 makeNaviLink ($cat)
 getPathCat ($cat)
 getArticleMarker ($article, $priceid=true)
 makeAdressView ($addressArray, $subpartMarker)
 makeBasketView ($basketObj, $subpartMarker, $articletypes=false, $lineTemplate= '###LISTING_ARTICLE###')
 makeBasketInformation ($basketObj, $subpartMarker)
 makeLineView ($basketItemObj, $subpartMarker)
 addTypoLinkToTS ($TSArray, $TypoLinkConf)
 generateMarkerArray ($data, $TS, $prefix='', $table='')
 renderValue ($value, $TStype, $TSconf)
 renderCategory ($category, $subpartName, $TS, $prefix='', $template= '')
 renderElement ($element, $subpartName, $TS, $prefix='', $markerWrap= '###', $template= '')
 formatAttributeValue ($matrix, $myAttributeUid)
 error ($methodName, $line, $errortext, $aditionaloutput=false)
 makeProduktAttributList ($myProduct)
 makeArticleAttributList (&$prodObj, $articleId=array())
 makeSingleView ()
 getArticleAmount ($articleId, $TSconf=false)
 renderProductsForList ($categoryProducts, $templateMarker, $iterations, $TS_marker='')
 renderProduct ($myProduct, $template, $TS, $articleMarker, $articleSubpart='', $iteration='')
 addFormMarker ($markerArray, $wrap=false)
 makeArticleView ($kind, $articles, $product)

Public Attributes

 $extKey = 'commerce'
 $imgFolder = ''
 $showCurrency = true
 $currency = 'EUR'
 $languageMarker = array()
 $basketHashValue = false
 $useRootlineInformationToUrl = 0
 $cat

Detailed Description

tx_commerce includes

Member Function Documentation

tx_commerce_pibase::addAdditionalLocallang (   ) 
 

Getting additional locallang-files through an Hook

tx_commerce_pibase::addFormMarker (  $  markerArray,
$  wrap = false
) 
 

Addsd the global Marker for the formtags to the given marker array

Author:
Ingo Schmitt <is@marketing-factory.de>
Parameters:
$markerArray array Array of marker
$wrap [default=false] if the marker should be wrapped by $wrap.
Returns:
array Marker Array with the new marker

tx_commerce_pibase::addTypoLinkToTS (  $  TSArray,
$  TypoLinkConf
) 
 

Adds the the commerce TYPO3 Link parameter for commerce to existing typoLink StdWarp if typolink.setCommerceValues =1 is set.

Parameters:
$TSArray Array Existing TypoScriptConfiguration
$TypoLinkConf Array TypoLink Configuration, buld bie view Method
Returns:
Array Changed TypoScript Configuration
Author:
Ingo Schmitt <is@marketing-factory.de>
Since:
12. August 2007

tx_commerce_pibase::error (  $  methodName,
$  line,
$  errortext,
$  aditionaloutput = false
) 
 

Returns an string concerning the actial error plus adding debug of $this->conf;

Parameters:
string $methodName Methdo Name from where thsi error is called
integer $line line of code (normally should be __LINE__)
string $errortext Text for this error
string $aditionaloutput Aditional code output in
 

  




Returns:
string HTML Code

    		
  







  

    
      

        

          tx_commerce_pibase::formatAttributeValue           
          ( 
          $ 
           matrix, 
        

        

          
          
          $ 
           myAttributeUid
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Formates the attribute value concerning the sprinf formating if value is a number 
Parameters:

  

    
array $matrix AttributeMatrix 

    
integer $myAttributeUid Uid of attribute 

  




Returns:
Formated Value 


Author:
Ingo Schmitt <is@marketing-factory.de> 


Todo:
create how to use this method when coding new stuff



Default return

return if empty    

  







  

    
      

        

          tx_commerce_pibase::generateLanguageMarker           
          ( 
                    
           ) 
          
        

      

    		
  





  

    
       
    
    



Gets all "lang_ and label_" Marker for substition with substituteMarkerArray 
Since:
10.02.06 Changed to XML  Frank Kroeber <fk@marketing-factory.de> 


Returns:
void

    		
  







  

    
      

        

          tx_commerce_pibase::generateMarkerArray           
          ( 
          $ 
           data, 
        

        

          
          
          $ 
           TS, 
        

        

          
          
          $ 
           prefix = '', 
        

        

          
          
          $ 
           table = ''
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Generates a markerArray from given data and TypoScript 
Parameters:

  

    
array $data Assoc-Array with keys as Database fields and values as Values 

    
array $TS TypoScript Configuration 

    
string prefix for marker, default empty 

    
string tx_commerce table name 

  




Returns:
array Marker Array for using cobj Marker array methods 


Todo:
create how to use this method when coding new stuff 

    		
  







  

    
      

        

          tx_commerce_pibase::getArticleAmount           
          ( 
          $ 
           articleId, 
        

        

          
          
          $ 
           TSconf = false
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Return the amount of articles for the basket input form


Parameters:

  

    
integer $articleId the articleId check for the amount

  



    		
  







  

    
      

        

          tx_commerce_pibase::getArticleMarker           
          ( 
          $ 
           article, 
        

        

          
          
          $ 
           priceid = true
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders the Article Marker and all additional informations needed for a basket form This Method will not replace the Subpart, you have to replace your subpart in your template by you own 
Parameters:

  

    
article Article Object the marker based on 

    
priceid boolean if set tu true (default) the price-id will berendered into the hiddenfields, otherwhise not 

  




Returns:
$markerArray Array with all marker needed for the article and the basket form 


Author:
Volker Graubaum <vg_typo3@e-netconsulting.de>

STARTFRM and HIDDENFIELDS are old marker, used bevor Version 0.9.3 Still existing for compatibility reasons

Please use ARTICLE_HIDDENFIEDLS, ARTICLE_FORMACTION and ARTICLE_FORMNAME, ARTICLE_HIDDENCATUID

Bild Link to put one of this article in basket    

  







  

    
      

        

          tx_commerce_pibase::getPathCat           
          ( 
          $ 
           cat          
           ) 
          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::init           
          ( 
          $ 
           conf          
           ) 
          
        

      

    		
  





  

    
       
    
    






Reimplemented in tx_commerce_pi1, tx_commerce_pi2, tx_commerce_pi3, and tx_commerce_pi5.    

  







  

    
      

        

          tx_commerce_pibase::makeAdressView           
          ( 
          $ 
           addressArray, 
        

        

          
          
          $ 
           subpartMarker
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders on Adress in the template This Method will not replace the Subpart, you have to replace your subpart in your template by you own 
Parameters:

  

    
Address Array (als Resultset from Select DB or Session) 

    
Subpart Template subpart 

  




Returns:
$content HTML-Content from the given Subpart. 


Author:
Ingo Schmitt <is@marketing-factory.de>

    		
  







  

    
      

        

          tx_commerce_pibase::makeArticleAttributList           
          ( 
          &$ 
           prodObj, 
        

        

          
          
          $ 
           articleId = array()
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Make the HTML output with list of attribute from a given product, reduced for some articles if article ids are givens

Real alternative Layout 
Parameters:

  

    
object $prodObj: Object for the current product, the attributes are taken from 

    
array $article: array with articleIds for filtering attributss 

  




Returns:
string Stringoutput for attributes 

    		
  







  

    
      

        

          tx_commerce_pibase::makeArticleView           
          ( 
          $ 
           kind, 
        

        

          
          
          $ 
           articles, 
        

        

          
          
          $ 
           product
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::makeBasketInformation           
          ( 
          $ 
           basketObj, 
        

        

          
          
          $ 
           subpartMarker
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders from the given Basket the Sum Information to HTML-Code This Method will not replace the Subpart, you have to replace your subpart in your template by you own 
Parameters:

  

    
BasketObj Basket Object 

    
Subpart Template Subpart 

    
array of articletypes 

  




Returns:
$content HTML-Ccontent from the given Subpart 


Author:
Ingo Schmitt <is@marketing-factory.de>  Redersn the following MARKER ##LABEL_SUM_ARTICLE_NET### ##SUM_ARTICLE_NET### ##LABEL_SUM_ARTICLE_GROSS### ##SUM_ARTICLE_GROSS### ##LABEL_SUM_SHIPPING_NET### ##SUM_SHIPPING_NET### ##LABEL_SUM_SHIPPING_GROSS### ##SUM_SHIPPING_GROSS### ##LABEL_SUM_NET### ##SUM_NET### ##LABEL_SUM_TAX### ##SUM_TAX### ##LABEL_SUM_GROSS### ##SUM_GROSS###

Hook for processing Marker Array Inspired by tt_news 
Since:
01.02.2006

    		
  







  

    
      

        

          tx_commerce_pibase::makeBasketView           
          ( 
          $ 
           basketObj, 
        

        

          
          
          $ 
           subpartMarker, 
        

        

          
          
          $ 
           articletypes = false, 
        

        

          
          
          $ 
           lineTemplate = '###LISTING_ARTICLE###'
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders the given Basket to the Template This Method will not replace the Subpart, you have to replace your subpart in your template by you own 
Parameters:

  

    
BasketObj Basket Object 

    
Subpart Template Subpart 

    
array of articletypes 

  




Returns:
$content HTML-Ccontent from the given Subpart 


Author:
Ingo Schmitt <is@marketing-factory.de>

Check if the subpart is existing, and if not, remove from array

Get All Articles in this basket and genarte HTMl-Content per row

Only if valid parameter    

  







  

    
      

        

          tx_commerce_pibase::makeLineView           
          ( 
          $ 
           basketItemObj, 
        

        

          
          
          $ 
           subpartMarker
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders the given Basket Ite, This Method will not replace the Subpart, you have to replace your subpart in your template by you own 
Parameters:

  

    
BasketItemObj Basket Object 

    
Subpart Template Subpart 

  




Returns:
$content HTML-Ccontent from the given Subpart 


Author:
Ingo Schmitt <is@marketing-factory.de>  Renders the following MARKER ##PRODUCT_TITLE### ##PRODUCT_IMAGES###

 ##PRODUCT_SUBTITLE###

##LANG_ARTICLE_NUMBER### ##ARTICLE_EANCODE###

##PRODUCT_LINK_DETAIL### ##LANG_PRICE_NET### ##BASKET_ITEM_PRICENET###

 ##LANG_PRICE_GROSS### ##BASKET_ITEM_PRICEGROSS###

 ##LANG_TAX### ##BASKET_ITEM_TAX_VALUE### ##BASKET_ITEM_TAX_PERCENT###

 ##LANG_COUNT### ##BASKET_ITEM_COUNT###

 ##LANG_PRICESUM_NET### ##BASKET_ITEM_PRICESUM_NET### 

 ##LANG_PRICESUM_GROSS### ##BASKET_ITEM_PRICESUM_GROSS### 

  Locallang Handling in language ..

Basket Item Elements

: TypoScript formationg of percentage

Hook for processing Marker Array Inspired by tt_news 
Since:
01.02.2006

Basket Artikcel Lementes    		
  







  

    
      

        

          tx_commerce_pibase::makeListView           
          ( 
                    
           ) 
          
        

      

    		
  





  

    
       
    
    



Makes the list view for the current categorys

clean up, make it more flexibles 
Returns:
string the content for the list view

Category LIST

Since 29.09.2006 -> Added Hash for basket to array

Build TS for Linking the Catergory Images

Build the link  Please use TYPOLINK instead

Insert the Productlist    

  







  

    
      

        

          tx_commerce_pibase::makeNaviLink           
          ( 
          $ 
           cat          
           ) 
          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::makeProduktAttributList           
          ( 
          $ 
           myProduct          
           ) 
          
        

      

    		
  





  

    
       
    
    



calls renderProductAtrributeList with parametres from $this 
See also:
renderProductAttributeList 


Returns:
string Stringoutput for attributes 

    		
  







  

    
      

        

          tx_commerce_pibase::makeSingleView           
          ( 
                    
           ) 
          
        

      

    		
  





  

    
       
    
    



Makes the single view for the current products

clean up, make it more flexibles 
Returns:
string the content for a single product 

    		
  







  

    
      

        

          tx_commerce_pibase::renderArticleAttributeList           
          ( 
          &$ 
           prodObj, 
        

        

          
          
          $ 
           articleId = array(), 
        

        

          
          
          $ 
           subpartNameArray = array()
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders HTML output with list of attribute from a given product, reduced for some articles if article ids are givens with possibility to define a number of templates for interations. when defining 2 templates you have an odd / even layout

Real alternative Layout 
Parameters:

  

    
object $prodObj: Object for the current product, the attributes are taken from 

    
array $article: array with articleIds for filtering attributss 

    
array $subpartNameArray: array of suppart Names 

  




Returns:
string Stringoutput for attributes


Since:
2006.07.18 Output for Attribute Icons 


Author:
Joerg Sprung <jsp@marketing-factory.de>


Since:
2006.07.18 Output for Attribute Icons 


Author:
Joerg Sprung <jsp@marketing-factory.de>

    		
  







  

    
      

        

          tx_commerce_pibase::renderCategory           
          ( 
          $ 
           category, 
        

        

          
          
          $ 
           subpartName, 
        

        

          
          
          $ 
           TS, 
        

        

          
          
          $ 
           prefix = '', 
        

        

          
          
          $ 
           template = ''
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Reders a category as output 
Parameters:

  

    
object $category tx_commerce_category object 

    
string $subpartName template-subpart-name 

    
array $TS TypoScript array for rendering 

    
string $prefix Prefix for Marker, optional# 

  




Returns:
string HTML-Content


Todo:
create how to use this method when coding new stuff * 

    		
  







  

    
      

        

          tx_commerce_pibase::renderElement           
          ( 
          $ 
           element, 
        

        

          
          
          $ 
           subpartName, 
        

        

          
          
          $ 
           TS, 
        

        

          
          
          $ 
           prefix = '', 
        

        

          
          
          $ 
           markerWrap = '###', 
        

        

          
          
          $ 
           template = ''
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Reders an element as output 
Parameters:

  

    
object $element tx_commerce_* object 

    
string $subpartName template-subpart-name 

    
array $TS TypoScript array for rendering 

    
string $prefix Prefix for Marker, optional# 

    
string $markerWrap $secondPrefix for Marker, default ### 

  




Returns:
string HTML-Content


Todo:
create how to use this method when coding new stuff

    		
  







  

    
      

        

          tx_commerce_pibase::renderProduct           
          ( 
          $ 
           myProduct, 
        

        

          
          
          $ 
           template, 
        

        

          
          
          $ 
           TS, 
        

        

          
          
          $ 
           articleMarker, 
        

        

          
          
          $ 
           articleSubpart = '', 
        

        

          
          
          $ 
           iteration = ''
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



This method renders a product to a template 
Parameters:

  

    
$myProduct tx_commerce_product object 

    
$template TYPO3 Template 

    
$TS Typoscript Objkect 

    
$articleMarker Marker for the article description to be filled up with makeArticleView 

    
articleSubpart [optional] 

    
iteration [optional] Number of iteration, not used, only for own implementation needed 

  




See also:
makeArticleView 


Returns:
string renderd HTML

Build TS for Linking the Catergory Images

Generate TypoLink Configuration and ad to fields by addTypoLinkToTs

Get The Checapest Price    

  







  

    
      

        

          tx_commerce_pibase::renderProductAttributeList           
          ( 
          $ 
           prodObj, 
        

        

          
          
          $ 
           subpartNameArray = array(), 
        

        

          
          
          $ 
           TS = false
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders Product Attribute List from given product, with possibility to define a number of templates for interations. when defining 2 templates you have an odd / even layout 
Parameters:

  

    
object $prodObj: Product Object 

    
array [optional] $subpartNameArray: array of suppart Names 

    
array [optional] $TS Configuration 

  




Returns:
string HTML-Output rendert


Since:
2006.07.13 Output for Attribute Icons 


Author:
Joerg Sprung <jsp@marketing-factory.de>

    		
  







  

    
      

        

          tx_commerce_pibase::renderProductsForList           
          ( 
          $ 
           categoryProducts, 
        

        

          
          
          $ 
           templateMarker, 
        

        

          
          
          $ 
           iterations, 
        

        

          
          
          $ 
           TS_marker = ''
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::renderValue           
          ( 
          $ 
           value, 
        

        

          
          
          $ 
           TStype, 
        

        

          
          
          $ 
           TSconf
        

        

          
          ) 
          
        

      

    		
  





  

    
       
    
    



Renders one Value to TS Availiabe TS types are IMGTEXT, IMAGE, STDWRAP 
Parameters:

  

    
mixed $value Outputvalue 

    
string $TStype TypoScript Type for this value 

    
array $TSconf TypoScript Config for this value 

  




Todo:
create how to use this method when coding new stuff * 
Returns:
string html-content 





If you add more TS Types using the imgPath, you should add these also to generateMarkerArray    

  




Member Data Documentation





  

    
      

        

          tx_commerce_pibase::$basketHashValue = false          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::$cat          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::$currency = 'EUR'          
        

      

    		
  





  

    
       
    
    






Reimplemented in tx_commerce_pi1, tx_commerce_pi2, tx_commerce_pi3, and tx_commerce_pi5.    

  







  

    
      

        

          tx_commerce_pibase::$extKey = 'commerce'          
        

      

    		
  





  

    
       
    
    






Reimplemented in tx_commerce_pi1, tx_commerce_pi2, tx_commerce_pi3, tx_commerce_pi5, and tx_commerce_pi6.    

  







  

    
      

        

          tx_commerce_pibase::$imgFolder = ''          
        

      

    		
  





  

    
       
    
    






Reimplemented in tx_commerce_pi2, tx_commerce_pi3, and tx_commerce_pi5.    

  







  

    
      

        

          tx_commerce_pibase::$languageMarker = array()          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::$showCurrency = true          
        

      

    		
  





  

    
       
    
    



    

  







  

    
      

        

          tx_commerce_pibase::$useRootlineInformationToUrl = 0          
        

      

    		
  





  

    
       
    
    



    

  




The documentation for this class was generated from the following file:

Generated on Sun Jan 13 23:12:26 2008 for tx_commerce by 

doxygen 1.4.4