Class: CartPluginInterface_1_0

Source Location: /modules/cart/classes/CartPluginInterface_1_0.class

Class CartPluginInterface_1_0

Class Overview

This is an interface for plugins to the Cart module. Modules that wish to be able to do fulfillment on items in the cart (like eCommerce, photo printing, zip download, etc) must provide a class that implements this interface.

Located in /modules/cart/classes/CartPluginInterface_1_0.class [line 41]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
ViewCartTestCartPlugin1_0
CartPluginInterface_1_1	This is an interface for plugins to the Cart module. Modules that wish to be able to do fulfillment on items in the cart (like eCommerce, photo printing, zip download, etc) must provide a class that implements this interface.

[ Top ]

Method Summary

array	fulfillCart()	Do whatever magic this plugin wants to do with the cart
array	getActionDisplayName()	Get the localized name of the action (eg. "Print with Shutterfly") to show to users.
array	getSupportedItemTypes()	Return the item types that this cart plugin can fulfill, e.g.

[ Top ]

Methods

fulfillCart [line 69]

array fulfillCart(

$cartItemIds 
)

Do whatever magic this plugin wants to do with the cart

Parameters:

$cartItemIds:

API Tags:

Return:

GalleryStatus a status code array url components that can be passed to the UrlGenerator

Redefined in descendants as:

[ Top ]

getActionDisplayName [line 59]

array getActionDisplayName(
)

Get the localized name of the action (eg. "Print with Shutterfly") to show to users.

API Tags:

Return:

GalleryStatus a status code string the action display name

Redefined in descendants as:

[ Top ]

getSupportedItemTypes [line 49]

array getSupportedItemTypes(
)

Return the item types that this cart plugin can fulfill, e.g.

array('GalleryPhotoItem', 'GalleryMovieItem')

API Tags:

Return:

item types

Redefined in descendants as:

[ Top ]

Documentation generated on Fri, 03 Oct 2008 04:46:32 -0700 by phpDocumentor 1.3.0RC6

	Cart Classes

[ class tree: Cart ] [ index: Cart ] [ all elements ]