ShoppingCart

Xataface Shopping Cart Module

Status: Under development Current Version: 0.2

Synopsis

Add a shopping cart to your xataface application. You can treat any record as a product that can be sold. Includes Paypal connectivity, shipping calculation, and more.

Requirements

• Xataface 1.0 or higher
• PHP 5 or higher
• MySQL 4.1 or higher

Installation Instructions

1. Download the ShoppingCart module, extract it, and place the ShoppingCart directory in your Xataface modules directory. (i.e. /path/to/xataface/modules/ShoppingCart).
2. Add the following line to the [_modules] section of your conf.ini file:

   modules_ShoppingCart=modules/ShoppingCart/ShoppingCart.php

3. Add the following to the beginning of your index.php file?:

   function __autoload($class){
       if ( $class == 'ShoppingCart' ) require_once 'modules/ShoppingCart/lib/ShoppingCart/ShoppingCart.class.php';
   }

4. In the fields.ini file for any table whose records you wish to represent items for sale, add the following:

   [__implements__]
       InventoryItem=1

5. Specify which fields should be used for the item description, price, width, height, length, and weight in the fields.ini file for each table whose records you wish to represent items for sale by adding the following directives to the appropriate fields:

   ShoppingCart.description=1
   ShoppingCart.unitPrice=1
   ShoppingCart.weight=1
   ShoppingCart.width=1
   ShoppingCart.height=1
   ShoppingCart.length=1

   E.g. if your table has a field named ""price"" that you want to represent the unit price, you would have something like:

   [price]
       ShoppingCart.unitPrice=1

   The shopping cart module will make its best guess on which fields to use for these values if they are not explicitly specified.
6. Specify the paypal account where money should be deposited by adding the following to your application's actions.ini file:

   [view_cart]
       paypal.account="youremail@example.com"

Usage Instructions

Once the Shopping Cart module is installed you can:

1. Add items to your shopping cart
2. View your cart contents
3. Checkout and pay with paypal

Adding Items to the Cart

In the View tab of any salable record, you'll notice a little block on the left side of the page with the heading "Add Item to Cart". This includes a field to specify the quantity and a button to add the item to the shopping cart.

Viewing Cart Contents

The Shopping Cart module automatically introduces an action to view the cart contents. This action is named "view_cart". Hence you can always view the cart contents by entering the URL: index.php?-action=view_cart .

Checking Out

1. View the cart contents.
2. Click "Check out"
3. This will take you to a paypal page to pay for your items.

Actions

This module adds the following actions to your application.

Blocks and Slots

This module adds the following blocks and slots to your applications.

Application Delegate Class Hooks

You can modify the shopping cart behavior by defining the following methods to the application delegate class.

Table Delegate Class Hooks

You can modify the behavior of the shopping cart by defining the following methods to the delegate class of any table that implements the InventoryItem ontology (i.e. any table that is to be used to store products that can be added to the cart).

Internal Storage

This module creates the following tables to store its data:

dataface__invoices

The dataface__invoices table stores the actual invoices for purchases made. An invoice is automatically created as soon as the user "checks out".

dataface__shipping_methods

Stores the available shipping methods.

Payment Handlers

Information about payment handlers to be added here.

Shipping Handlers

The Shopping Cart module is itself modular, allowing you to develop custom shipping handlers for different types of shipping. A shipping handler is responsible for calculating shipping costs to a destination address. Currently only a UPS shipping handler has been created, but it is not difficult to create other handlers.

Shipping Handler Public Interface