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

Class: CartHelper

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

Class CartHelper

Class Overview

Utility functions useful in managing Carts

Located in /modules/cart/classes/CartHelper.class [line 35]



		
		
		
		

Methods

[ Top ]
Method Summary
GalleryStatus   addItemsToCart()   Add the item ids to the user's cart (Note that view permission should be checked in advance; this function only checks cart.add permission)
array   fetchCartItemCounts()   Return the ids of the items in the cart
array   loadCartItems()   Load entities for all cart items.
GalleryStatus   setCartItemCounts()   Store cart contents

[ Top ]
Methods
addItemsToCart  [line 63]

  GalleryStatus addItemsToCart( array $ids  )

Add the item ids to the user's cart (Note that view permission should be checked in advance; this function only checks cart.add permission)

Parameters:
array   $ids:  int item ids

API Tags:
Return:  a status code


[ Top ]
fetchCartItemCounts  [line 43]

  array fetchCartItemCounts( )

Return the ids of the items in the cart


API Tags:
Return:  GalleryStatus a status code array (itemId => count, itemId => count, ..)


[ Top ]
loadCartItems  [line 124]

  array loadCartItems( )

Load entities for all cart items.

Remove any invalid ids from cart.


API Tags:
Return:  GalleryStatus a status code array of items


[ Top ]
setCartItemCounts  [line 104]

  GalleryStatus setCartItemCounts( array $cartItemIds  )

Store cart contents

Parameters:
array   $cartItemIds:  (itemId => count, itemId => count, ..)

API Tags:
Return:  a status code


[ Top ]

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