DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Meta OS Commerce

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed:2008-07-01T09:15:19
Classification:Front end shop module
Email:typo3@metaphore.fr
Info 2:
Info 3:
Info 4:

EXT: Meta OS Commerce

Extension Key: meta_oscommerce

Copyright 2000-2002, typo3@metaphore.fr, <typo3@metaphore.fr>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Meta OS Commerce 1

Introduction 2

Special Thanks 2

Apologize 2

Screenshots 3

Global Front End products display list 3

Listed by meta_feedit filtered on family name (one product by family name displayed) (added input in oscommerce) 3

meta_feedit after selecting family name (all products of a family name displayed) 3

Installation 4

Before installing the extension (mandatory step) 4

Extensions manager 4

Module configuration 7

Template configuration 8

Plugin Configuration 9

The tree 9

Configuring all pages 9

Realurl configuration 10

Own contributions 11

Redirecte on unique product 11

Flash file overriding pictures 11

Changing added date 11

French VAT 11

Model display 11

Advanced shipping price management 11

Known bugs 13

Changelog 14

TO-DOs and notes 15

Introduction

This plugin allow developpers to quickly and easily make a complet shop system on typo3 web site. It's based on OS Commerce 2.2 Milestone 2.

It provides a small management plugin so the user of typo3 can add pages for categories of products or other things simply. The OS Commerce interface is also keeped so it's easy to access.

I started develop the TCA so we can use it to display products using meta_feedit extension instead of the classic page shop included in OS Commerce. I'll make screen for you.

Special Thanks

I used developments made in the «Snoopy - the PHP net client» modified for having this extension working. Thank you for all the efforts you made.

Apologize

We apologize the fact that we have forgotten to test the extension without configuring the .htaccess file. Without this configuration it appear that the extension will never work properly and it become a mandatory step.

Sorry for the inconvenians.

Screenshots

Global Front End products display list

img-1

Listed by meta_feedit filtered on family name (one product by family name displayed) (added input in oscommerce)

img-2 meta_feedit after selecting family name (all products of a family name displayed)

img-3

Installation

((generated))

Before installing the extension (mandatory step)

To get the extension working properly, you have to configure the .htaccess file in the typo3 root else the shop will never show correctly.

Edit the file and add after : 'RewriteEngine On' the following line:

RewriteRule catalog/(.*) /typo3conf/ext/meta_oscommerce/mod1/oscommerce/$1 [L]

Where catalog is the virtual directory where the shop will be accessible.

Important : In all the shop installation when it ask the shop home you must set you «catalog» directory.

Extensions manager

Please take care to desactivate dbal extension, it cancel the sql insertion.

When you click to install the extension it made all change needed on database and perform the insert static :

img-4

img-5

In tne Install you need to put the url of you web site and the url for accessing the shop (you may redirect all by .htaccess like I do). The last parameter is the page id wich will be used for traitement link (détail page principaly).

Important note : The domain of the site must be a real domain (or a dyndns / noip domain) because the meta_oscommerce try to retrieve the page trough this url.

After that you can refreash you browser to see the shop system in user part :

img-6

Follow all steps af the installation (and there you may change the «/typo3conf/ext/meta_oscommerce/mod1/oscommerce/») url, it must be the same than 'adresse of the shop system' inserted at the installation.

Thats all... You can now acces of commerce configuration.

Module configuration

All you need to do is configure the shop and insert your products ;)

img-7

Template configuration

Please include meta_oscommerce in your template in the page where the shop will start.

img-8

You can redefine all variable from the installation here, and also you car redefine the stylesheet used.

You have access in the constant to :

# absolute url of the web site

plugin.metaoscommerce.adresse_base = http://www.domain.com/

# name of the stylesheet to include

plugin.metaoscommerce.catalogue_css = typo3conf/ext/meta_oscommerce/mod1/oscommerce/stylesheet.css

# page id for traitement plugin

plugin.metaoscommerce.page_cible = 4

The setup template also put the no cache option, needed on all pages of the shop (for session and refresh of product list)

Plugin Configuration

The tree

img-9

You can make a tree styurure like this :

  • Home (here Accueil) : This is where all start ;) the root of the shop
  • Processing page (here Détail magasin) : here will be the plugin for the processing page, it's also the page user during the installation of the plugin or the number you define in typoscript (plugin.metaoscommerce.page_cible = 4)
  • My account (here Mon compte) : page displaying the account of the customer
  • Shopping cart (here Panier) : page displaying the cart of the front end visitor.
  • Other pages (here Catégorie 1 & 2) : page displaying a particular product categorie.

Configuring all pages

Here we configure all the plugin : processing page

img-10

Leave the first option selected to have the processing page needed. It's all you need to do.

For special pages like Home, account, shopping cart and other special page (promotion, new poducts, ...) you can select the appropriate option in the list : exemple for account page :

img-11

At the end of the list you have access to all categories you create in OS Commerce for exemple you have categories 1 & 2 and subcategories 1 & 2 for each you will obtain this :

img-12

That's all you have just finish configuring your new shop system.

Realurl configuration

With rewrited parameter (vers 0,0,10), the «tx_metaoscommerce_pi1[oscommerceURL]» parameter now contains a shortMD5 of URL. So it can now easily be rewrited by RealUrl

You can use this parameter (in your RealUrl conf)

«cat» text is just for example.

'postVarSets' => array(

'_DEFAULT' => array(

'cat'=>array(

array(

'GETvar' => 'tx_metaoscommerce_pi1[oscommerceURL]',

),

),

),

),

URL will look like :

/en/shop/cat/50acd236ae.html

rather than

/en/shop.html?tx_metaoscommerce_pi1[oscommerceURL]=.......

Own contributions

Redirecte on unique product

OsCommerce when we want to list a category show all item in them, even if there's only one product in. The parameter «REDIRECT_ON_UNIQUE» (bool: true by default) wich can be found in «includes/param_perso.php» enable the fact that if we only have one product in a category, we acces directely to the product description.

Flash file overriding pictures

OsCommerce will only able you to insert picture for an item. The contricution able you to insert flash file (swf only) You can activate this by changing the parameter «ENABLE_FLASH» (bool: true by default) located in «includes/param_perso.php». In this file you'll find too display parameters for flash file, like the width and the height.

Changing added date

By default the added date of the product is set to the date where the product was realy added to the shop. This parameter added a date selector for the «added date» of the product. «SHOW_DATE_ADDED» (bool: false by default)

French VAT

We have modifyed the VAT calcul of OsCommerce to be close of the frend law. So if you want to develop a french shop and use our parameter simply change «OSC_FR» to true (bool: true by default)

Note that even f true, it doesn't affect other system.

Model display

If you don't use product model you can disable the front end display of this information. «AFF_MODEL» (bool: false by default)

Advanced shipping price management

If you shipping modules use string like 'weight:price' [, weight:price [...]] You can now have a nice grid to edit them. All you have to do is to declare «tep_draw_weight_price_field(» as «set_function» for the field you use for pricing.

If set you see a small edit button accoling to the field:

img-13

When you clic on it you will show the fallowing wizard (only in french for now and not realy nice, but working ;) thanks Romain) :

img-14

That's done!

You can learn into «normal» shipping modules to learn how to declare.

Known bugs

  • Even if product and categories are listed in the BE you can't edit them (bugs may appear if you do).
  • Certainly other problems not listed ...

Changelog

0.1.0 :

Important Release !

Important installation note, mandatory step :

Explain configuration of the the .htaccess file

We sincerely apologize for the forgotten part of the documentation!

0.0.11 :

Advanced shipping price management, easier way to change price for plugin.

Updated documentation with description of own contribution.

0.0.10 :

use «rewrited parameter» (no mode URL in parameter)

0.0.9 :

Small corrections and bug fixes

0.0.8 :

Install bug fix when changing value of db param.

Add 'France Métropolitaine' in 'France' zone.

Add 'France Métropolitaine' in 'UE' zone.

Correction of the search engine.

Add some pages in plugin configuration.

0.0.7 :

Better implementation in backend, now take the force-charset of typo3 localconf.php if found (for utf-8 for example).

Bug fixe on the Atos module for French commerce

0.0.6 :

Some bug fixes.

Added categories listing box and quicksearch box in the plugin.

0.0.5 :

Major update. V0.0.4 seem to be an unworking version, please update.

Product attribute can now be more easily managed by clicking button on product listing page. It show a simplified page with only the product selected. Attribute list are now filtered and association can be done easier.

0.0.4:

Added possibility to organise language convertion between typo3 and oscommerce (learn documentation to know how to keep your parameter).

Correct the manufacturer filter, now work well.

0.0.3:

Minor SQL table définition correction and addiction.

0.0.2:

SQL correction (add some columns).

Remove catalogue directory configuration from constant (obsolete).

Configure shop to be translated in english first (it was in french before).

Added information about conflict with dbal extension (v 0.9.9, may be corrected in future version)

Added important note about the domain configuration (domain name must be real).

0.0.1:

First Upload.

TO-DOs and notes

  • Complete TCA description.
  • Explain how it work with meta_feedit (changing uid and relation in tca description for meta_feedit).
  • Transform fonctionnement into template for easier use and configuration of the disposition.
  • Enable wrap objects.
  • Enable gifbuilder objects.
  • Make translation in other language than french ;)
  • Make installation available in other language than french
  • Certainly some other possibilities ...
  • Integrate modification by Martin Sillman. ;) thanks guy!
  • Integrate modification by Romain Coradinier (advanced shipping price management)

img-15 EXT: Meta OS Commerce - 15