EXT: zk_products¶

Description

The template-file.

See example in 'media/scripts/products_template.tmpl'

Description

The pid's from where to fetch categories, forums and so on. Default is the current page. Accepts multiple pid's commaseparated!

Description

Code to define, what the script does. Case sensitive:

TRACKING

BASKET, PAYMENT, FINALIZE, INFO

SEARCH, SINGLE, LIST

New: LISTOFFERS, LISTHIGHLIGHTS, LISTNEWITEMS, MEMO

Description

The default code (see above) if the value is empty. By default it's not set and a help screen will appear

Example:

plugin.tt_products.defaultCode = LIST

Description

Number of recursive levels to select tt_products from in lists.

Description

Lets you specify alternative subpart markers for the various main template designs in the shopping basket system.

This is the list of main subparts you can override:

Properties:

TRACKING_WRONG_NUMBER
TRACKING_ENTER_NUMBER
BASKET_REQUIRED_INFO_MISSING
BASKET_TEMP
ITEM_SINGLE_DISPLAY_RECORDINSERT
ITEM_SINGLE_DISPLAY
ITEM_SEARCH
ITEM_LIST_TEMPLATE
ITEM_SEARCH_EMPTY
BASKET_TEMPLATE
BASKET_INFO_TEMPLATE
BASKET_PAYMENT_TEMPLATE
BASKET_ORDERCONFIRMATION_TEMPLATE
EMAIL_PLAINTEXT_TEMPLATE

/+ stdWrap

Example:

This example changes the main subpart marker for the regular basket display from the default ###BASKET_TEMPLATE### to the custom supplied design ###BASKET_DESIGN2### (found in the same template HTML-file)

altMainMarkers.BASKET_TEMPLATE =  BASKET_DESIGN2
altMainMarkers.BASKET_TEMPLATE.wrap = ### | ###

Description

Additional search fields

Default internal list is title,note,itemnumber. Any fields you specify is added to these defaults.

Description

Max items displayed. The maximum number of items displayed on one page.

Description

The image configuration in single display

Description

The image configuration in list display

Description

The image configuration in basket display

Description

The image file displayed if no image was attached to a product. This image is processed by the IMAGE cObject which is active in the actual display of that image. That is, one of the above IMAGE cObjects.

Description

Display Category Header in list

If this option is set, the category headers (page titles) will automatically be displayed in the product lists. This is not always convenient because you might have chosen a header-title for the "list" content element.

Description

Display Category Header in basket.

If this option is set, the category headers (page titles) will automatically be displayed in the basket lists.

Description

Every time a product is display be it in the basket, list of single, the method getItemMarkerArray() in user_products is called. This function fills in and returns an array, socalled markerArray(), with key/values for template substitution.

If you enter a valid function name here (see datatype 'function-name' for details!) that array will be passed to that function as the second parameter. The first parameter will be the TypoScript properties to itemMarkerArrayFunc.

Parent PHP-Object reference:

.parentObj property is hardcoded to be a reference to the calling user_products object (PHP).

Example:

(provided that a function or class is included!)

itemMarkerArrayFunc = user_addFieldsMarkerArr
itemMarkerArrayFunc.simpleOption = 1

Description

PID for single item display.

If you want a certain page to be used for display of item details, please enter the PID (page-uid) here.

Description

PID for search page.

If you want all product searches to go to a specific page, enter the PID it here! NOTE: If you set this PID, all searchqueries will (must) be handled with a list content element with the code "search" on that page.

Description

PID for basket page.

If you want every change in the number of items anywhere to go to a specific page (eg. the shopping basket page), enter the PID here.

Description

PID for store root.

This is the PID of the rootPage of the store. If not set the store will operate over all pages from the root of the site. But if the site has many pages, performance may improve.

Description

PID for the sys_products_orders records. By default they will get the pid of the payment (finalize) page.

Description

PID for the info page where name and address is entered.

Description

PID for the confirmation page where the user confirms right before payment.

Description

PID for the thanks page.

Description

If this value is set, then each time a new order is created the order- number counter will be incremented with a random number between [first-integer] and [second integer].

Example

1,10   (This will increment the counter randomly between 1 and 10)
5,5    (This will increment the counter with 5 each time)

Description

The product details are parsed by these properties.

Description

Generates the category header.

Example:

categoryHeader = TEXT
categoryHeader.current = 1

Description

Sales TAX/VAT percentage.

Double value (!) (means, "use . as decimal point")

Example:

# Danish sales TAX is 25%:
TAXpercentage = 25.00

Description

Set this, if TAX is included in the database prices! ( ... and of course: Clear this, if TAX is not included in the database prices and should be added in the display of items)

All processing will take this flag into account and calculate prices accordingly.

Description

Price decimals

Description

Price Thousand point

Enter the thousand separator, if any.

Description

Currency symbol. Used in shop administration.

Example:

DKR
USD
$

Description

If set and a user is logged in, the address info of that fe_user is 'hardcoded' as billing address of the user.

Description

List of the fields which are required in the address information

Description

Prefix to the order numbers. Dont use spaces or special chars. Max 10 chars.

Description

From email address for the confirmation email to customer

Description

From name for the confirmation email to customer.

Description

Comma list of recipients of the order email. Shop and administrator/supervisor email addresses go here!

Description

If set, the order confirmation email is sent as HTML

Description

If email-notification for the customer is enabled by default (he can change it himself in the tracking module later)

Description

Status codes used in the tracking module.

Numbers above 100 removes the order from the tracklist.

Number zero is the status of a non-finalized order (and non-finalized orders in the database may by time be regarded as garbage...)

Numbers of 50-59 is available for the customer to choose from.

Number 1 is reserved to be selected when an order goes from zero to 1 because it's confirmed. Number 1 cannot be selected by shop admin.

Example:

statusCodes {
    1 = Order submitted by user
    2 = Order is received and accepted by store
    10 = Shop is awaiting goods from third-party
    11 = Shop is awaiting customer payment
    12 = Shop is awaiting material from customer
    20 = Goods shipped to customer
    30 = Other message from store
    50 = Customer request for cancelling
    51 = Message from customer to shop
    100 = Order shipped and closed
    101 = Order closed
    200 = Ordre cancelled
}

Description

The 'password' used by the administrator of the shop to go into the tracking system in the front end.

The password form field will appear if a BE_USER is logged in, but this password is still needed.

Description

stdWrap for status date

Example:

%e-%m-%y %H:%M

Description

stdWrap for the order date

Example:

%e-%m-%y

Description

If set, certain settings are manipulated in order to let the script render a single item - the $cObj->data.

If this setting is set, the subpart marked ###ITEM_SINGLE_DISPLAY_RECORDINSERT### will be used instead of the regular subpart ###ITEM_SINGLE_DISPLAY### if it's found.

Description

This cObject may be used to call a function which manipulates the shopping basket. This manipulation could be based on settings in an external order system. The output is included in the top of the order (HTML) on the basket-page.

This cObject is executed each time the main_products method of the user_products class in productsLib is called and it's executed before any of the main processing. See the class for details.

Description

This cObject may be used to call a function which clears settings in an external order system. This is a sister to the above function and they should probably be used in conjunction somehow. This function is called immediately after the finalize-function has been called.

For instance this function would be suitable for clearing any external basket facilitated by the .externalProcessing cObject

Note: The output is NOT included anywhere.

Description

Global Wrap 1. This will be splitted into the markers ###GW1B### and ###GW1E###. Don't change the input value by the settings, only wrap it in something.

Example:

wrap1.wrap = <b> |</B>

Description

Global Wrap 2 (see above)

Description

Value for ###GC1### marker (Global color 1)

Description

Value for ###GC2### marker (Global color 2)

Description

Value for ###GC3### marker (Global color 3)

Description

Configuration of payment and shipping methods, their values and costs and additional calculation scripts and payment gateways.

See description below!

Description

(Radio layout only)

If .radio is true, this string is the 'template' for the radio items.

Default is (in one line):

<nobr>###IMAGE### <input type="radio" name="recs[tt_products]['.$key.']" onClick="submit()" value="###VALUE###"###CHECKED###> ###TITLE###</nobr><BR>

Description

(Select layout only)

If .radio is false, this string wraps the <option> tags in a <select>-tag!

Default is (in one line):

'<select name="recs[tt_products]['.$key.']" onChange="submit()">|</select>'

Description

Configuration, see below

Examples:

10.title = Credit card
10.image.file = media/logos/dankort.gif
10.priceTax =
10.priceNoTax =
10.percentOfGoodstotal = 0
10.calculationScript = media/scripts/products_comp_calcScript.inc

30.title = By mail
30.image.file = media/logos/postdanmark.gif
30.priceTax = 40
30.priceNoTax = 32

Description

Title of item, eg. “Master card” or “Ground mail”

Description

Logo image for the item

Description

Price of item, including VAT

(notice you have to calculate the VAT amount here by yourself!)

Description

Price of item, excluding VAT

(notice you have to calculate the VAT amount here by yourself!)

Description

Price of item, calculated from a percentage of the total amount before payment/shipping

Description

PHP script which is included in a “blank” function and it should be written to manipulate amounts in the internal arrays.

This script could be used to calculate a special fee regarding a payment/shipping item.

For an example of application, see media/script/products_comp_calcScript.inc which shows you how to raise the final amount with 5.75% of it's own value as to compensate for fees to international credit card organisations.

Properties of the calculation script is passed to the function as $conf array.

Description

PHP script which is included in a “blank” method called from products_basket() in user_products class when the order is finalized.

This function must take care of displaying templates during the payment process with a payment gateway as well as finalizing the order afterwards.

See media/scripts/payment_DIBS.php for an example. A HTML-template file follows.

Properties of the handle script is passed to the function as $conf array. The content of the variable $content is returned as content.

Description

If set, this handleURL is called instead of the THANKS-url (by PIDthanks) in order to let eg. a handleScript process the information if payment by credit card or so.

Description

Alternative target for the form.

Description

shipping ONLY:

This is a list of payment method keys (their numbers) which are not available given a certain delivery form. For instance if people pick up goods in the store, you don't want them to transfer money or pay online but just order the goods. So you can exclude those payment methods.

Example:

...
  40.title = Pick up in store
  40.excludePayment = 10,40
}

Description

The ID of the memo page

Description

Payment ONLY:

This payment method is only available, if a user is logged in and member of this frontend user group

Description

Payment ONLY:

Additional required fields in the INFO page, if this payment method is selected. Useful for credit card payment.