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

tx_commerce_pi5 Class Reference

Inheritance diagram for tx_commerce_pi5:

tx_commerce_pibase List of all members.

Public Member Functions

 init ($conf)
 main ($content, $conf)
 getBillingAddress ($withTitle=1)
 getDeliveryAddress ()
 handlePayment ()
 getListing ($template=false)
 finishIt ()
 getBasketSum ($type= 'WEB')
 getAddress ($addressType, $newLine= '< br/>', $headstart= '< strong >', $headstop='</strong >')
 validateAddress ($addressType)
 getPaymentData ()
 getPaymentType ()
 getInputForm ($config, $step, $parseList=true)
 getAddressFromDB ($config, $step, $fieldList=array(), $getFromSession=true)
 handleAddress ($type)
 getInputField ($fieldName, $fieldConfig, $step)
 getSingleInputField ($fieldName, $fieldConfig, $step)
 getSelectInputField ($fieldName, $fieldConfig, $step)
 parseFieldList ($fieldConfig)
 canMakeCheckout ()
 sendUserMail ($orderUid, $orderData)
 sendAdminMail ($orderUid, $orderData)
 generateMail ($orderUid, $orderData)

Public Attributes

 $prefixId = "tx_commerce_pi5"
 $scriptRelPath = "pi5/class.tx_commerce_pi5.php"
 $extKey = "commerce"
 $imgFolder = ""
 $templateCode = ''
 $dbFieldData = array()
 $formError = array()
 $orderId
 $currency = ''

Detailed Description

tx_commerce includes


Member Function Documentation

tx_commerce_pi5::canMakeCheckout  ) 
 

Returns wether a checkout is allowed or not. Currently it always returns TRUE!!!

implement some checks

tx_commerce_pi5::finishIt  ) 
 

Finishing Page from Checkout

Returns:
string HTML-Content
Real finishing starts here !

See also:
http://www.php.net/uniqid
Send the emails

Do the output

tx_commerce_pi5::generateMail orderUid,
orderData
 

Generates one Mail

Parameters:
string $orderUid The Order UID
array $orderData Collected Order Data form PI3
Returns:
MailContent
Since The first line of the mail is the Suibject, trim the template

Hook for processing Marker Array Inspired by tt_news

Since:
21.01.2006

tx_commerce_pi5::getAddress addressType,
newLine = '<br />',
headstart = '<strong>',
headstop = '</strong>'
 

Returns a string that contains the address data of the specified type. The type can be 'billing' or 'delivery'.

Parameters:
string $addressType: The type of the address that should be exported from the session
string $newLine: The string that is used a splitter between the single lines
Returns:
String with address

tx_commerce_pi5::getAddressFromDB config,
step,
fieldList = array(),
getFromSession = true
 

tx_commerce_pi5::getBasketSum type = 'WEB'  ) 
 

This method returns an general overview about the basket content. It contains

  • price for all articles (sum net)
  • the price for shipping and package
  • the netto sum
  • the sum for tax
  • the end sum (gross)

Returns:
String with basket sum
Hook for processing Marker Array Inspired by tt_news
Since:
21.01.2006

tx_commerce_pi5::getBillingAddress withTitle = 1  ) 
 

Creates a form for collection the billing address data.

Hook for processing Marker Array Inspired by tt_news

Since:
21.01.2006

tx_commerce_pi5::getDeliveryAddress  ) 
 

Creates a form for collection the delivery address data.

Hook for processing Marker Array Inspired by tt_news

Since:
21.01.2006

tx_commerce_pi5::getInputField fieldName,
fieldConfig,
step
 

Returns a single input form field.

tx_commerce_pi5::getInputForm config,
step,
parseList = true
 

Creates a form from a table where the fields can prefilled, configured via TypoScript.

tx_commerce_pi5::getListing template = false  ) 
 

Method to list the content of the basket including all articles, sums and addresses.

Parameters:
Template for rendering
TS Coding with Sacha

Hook for processing Marker Array Inspired by tt_news

Since:
21.01.2006

tx_commerce_pi5::getPaymentData  ) 
 

tx_commerce_pi5::getPaymentType  ) 
 

Returns the payment type. The type is extracted from the basket object. The type is stored in the basket as a special article.

Returns:
A string that determines the payment type ('creditcard', 'invoice' or whatever

tx_commerce_pi5::getSelectInputField fieldName,
fieldConfig,
step
 

Returns a selectbox

tx_commerce_pi5::getSingleInputField fieldName,
fieldConfig,
step
 

Returns a single textfield

tx_commerce_pi5::handleAddress type  ) 
 

tx_commerce_pi5::handlePayment  ) 
 

This method handles all the stuff concerning the payment.

Hook for processing Marker Array Inspired by tt_news

Since:
21.01.2006

tx_commerce_pi5::init conf  ) 
 

Init Method, autmatically called $this->main

Parameters:
string $conf TypoConfiguration

Reimplemented from tx_commerce_pibase.

tx_commerce_pi5::main content,
conf
 

Main Method, automatically called by TYPO3 wher inserting the plugin

Parameters:
string $content from Parent Page
array $conf TS-Configuration
Returns:
string HTML-Content
Return if checkout is not allowed. Currently the method always returns TRUE right now. Some functionality has to be implemented in future.

tx_commerce_pi5::parseFieldList fieldConfig  ) 
 

Creates a list of array keys where the last character is removed from it.

tx_commerce_pi5::sendAdminMail orderUid,
orderData
 

Sends Admin Mail

Since:
12th November 2005 Also performes a charset Conversion for the mail, including Sender
Parameters:
Order ID
Order Data returns true if success
Since:
2005 12th November Noved to plainMailEncoded
Check if charset ist set by TS Otherwise set to default Charset Checck if mailencoding ist set otherwise set to 8bit

Convert Text to charset

Check if user Mail is set

tx_commerce_pi5::sendUserMail orderUid,
orderData
 

Sends the Information Mail to the user

Since:
12th November 2005 Also performes a charset Conversion for the mail
Parameters:
Order ID
Order Data returns true if success
Check for no injection codes

Since:
2005 12th November Noved to plainMailEncoded
Check if charset ist set by TS Otherwise set to default Charset Checck if mailencoding ist set otherwise set to 8bit

Convert Text to charset

tx_commerce_pi5::validateAddress addressType  ) 
 

Checks if an address in the SESSION is valid


Member Data Documentation

tx_commerce_pi5::$currency = ''
 

Reimplemented from tx_commerce_pibase.

tx_commerce_pi5::$dbFieldData = array()
 

tx_commerce_pi5::$extKey = "commerce"
 

Reimplemented from tx_commerce_pibase.

tx_commerce_pi5::$formError = array()
 

tx_commerce_pi5::$imgFolder = ""
 

Reimplemented from tx_commerce_pibase.

tx_commerce_pi5::$orderId
 

tx_commerce_pi5::$prefixId = "tx_commerce_pi5"
 

tx_commerce_pi5::$scriptRelPath = "pi5/class.tx_commerce_pi5.php"
 

tx_commerce_pi5::$templateCode = ''
 


The documentation for this class was generated from the following file:
Generated on Sun Jan 13 23:12:25 2008 for tx_commerce by  doxygen 1.4.4