/ 
Handel-0.18_01
River stage one • 2 direct dependents • 2 total dependents
/ Handel::Constants

NAME

Handel::Constants - Common constants used in Handel

SYNOPSIS

use Handel::Constants qw(:cart);

my $cart = Handel::Cart->new({
    shopper => 'D597DEED-5B9F-11D1-8DD2-00AA004ABD5E'
});

if ($cart->type == CART_TYPE_SAVED) {
    print 'This cart is saved!';
};

DESCRIPTION

Handel::Constants contains a set of constants used throughout Handel. It may be useful (or even a good idea) to use these in your code. :-)

By default, Handel::Constants export nothing. Use can use the export tags below to export all or only certain groups of constants.

METHODS

str_to_const($)

Converts a string version of a constant into that constants value.

print str_to_const('CART_TYPE_SAVED');  ## prints 1

CONSTANTS

CART_MODE_APPEND

All items in the saved cart will be appended to the list of items in the current cart. No effort will be made to merge items with the same SKU and duplicates will be left as seperate items.

CART_MODE_MERGE

If an item with the same SKU exists in both the current cart and the saved cart, the quantity of each will be added together and applied to the same sku in the current cart. Any price differences are ignored and we assume that the price in the current cart is more up to date.

CART_MODE_REPLACE

All items in the current cart will be deleted before the saved cart is restored into it. This is the default if no mode is specified.

CART_TYPE_SAVED

Marks the cart as permanent. Carts with this value set should never be automatically reaped from the database during cleanup.

CART_TYPE_TEMP

Any cart with this type could be purged form the database during cleanup at any time.

CHECKOUT_PHASE_INITIALIZE

The phase run when first creating a new order.

CHECKOUT_PHASE_VALIDATE

The phase run to validate address, shipping, and other information about an order.

CHECKOUT_PHASE_AUTHORIZE

The phase run when ahtorizing or validating credit card or other payment information.

CHECKOUT_PHASE_FINALIZE

The phase to run and post authorization order cleanup, like setting order number, before order delivery/confirmation.

CHECKOUT_PHASE_DELIVER

The phase run to deliver the order request to the vendor and/or customer.

CHECKOUT_DEFAULT_PHASES

Contains the default set of phases run automatically. This is currently, VALIDATE, AUTHORIZE, and DELIVER.

CHECKOUT_ALL_PHASES

Contains all available phases.

CHECKOUT_STATUS_OK

All plugin handlers returned successully and the checkout process has completed.

CHECKOUT_STATUS_ERROR

One or more plugin handlers returned an error or the checkout process aborted with errors.

CHECKOUT_HANDLER_OK

Specifies that the plugin handler sub has completed its work without errors.

CHECKOUT_HANDLER_DECLINE

Specifies that the plugin handler sub has opted not to perform any work. If your plugin is going to decline, please add a message to the current context using "add_handler" in Handel::Checkout

CHECKOUT_HANDLER_ERROR

Specifies that the plugin handler encountered errors and would like to abort the checkout process.

RETURNAS_AUTO

When calling load or items on Handel::Cart, it will attempt to return the most appropriate object. In list context, it will return a list. In scalar context, it will return a Handel::Iterator object. If the iterator only contains one item, that item will be returns instead.

RETURNAS_ITERATOR

Always return a Handel::Iterator object regardless of context or the amount of retults.

RETURNAS_LIST

Always return a list regardless of context or the amount of results.

RETURNAS_ARRAY

Same as RETURNAS_LIST

EXPORT_TAGS

The following %EXPORT_TAGS are defined for Handel::Constants. See Exporter for further details on using export tags.

:all

This exports all constants found in this module.

:cart

This exports all CART_* constants in this module.

:returnas

This exports all RETURNAS_* constants in this module.

AUTHOR

Christopher H. Laco
CPAN ID: CLACO
claco@chrislaco.com
http://today.icantfocus.com/blog/