Basket

\Bitrix\Sale\Basket class for handling shopping cart.

Chain of descendants (within subspace \Bitrix\Sale)

Basket > BasketBase > BasketItemCollection > Internals\EntityCollection > Internals\CollectionBase

Methods for parent class \Bitrix\Sale\BasketBase

Method	Description	Available from version
create	Creates shopping cart for the site $siteId.
getBasePrice	Returns general product cost without discounts and extra charges.
getExistsItemByItem	Search by item of the same product in shopping cart. Method returns shopping cart item on success.
getFUserId	Returns shopping cart owner ID (buyer).
getItemByBasketCode	Returns shopping cart item by ID.
getOrderableItems	Returns updated shopping cart for checkout, removing the items reserved or unavailable for purchase.
getPrice	Returns general cost for product with discounts and extra charges.
getRegistryType	Returns type of register for an object.
getSiteId	Returns site ID with associated shopping cart.
getVatRate	Allows getting VAT rate for products.
getVatSum	Returns general VAT amount for all products in shopping cart.
getWeight	Returns shopping cart weight.
loadItemsForFUser	Loads user shopping cart for specific site.
refresh	Refreshes data for products.
save	Saves shopping cart.
setFUserId	Sets shopping cart owner ID (buyer).
setOrder	Assigns order to shopping cart.
verify	Verifies product data.

Methods for parent class \Bitrix\Sale\BasketItemCollection

Method	Description	Available from version
createItem	Creates and adds an item into a collection.
getBasket	Abstract method. Returns shopping cart with specified collection.
getBasketItems	Returns a items collection.
getExistsItem	Returns an item from collection (or null).
getItemByBasketCode	Returns an item from collection by item code.
getItemById	Returns an item from collection by item ID.
getOrder	Returns order, associated to shopping cart.
getOrderId	Returns order ID with collection.
loadFromArray	Loads items from array.

Method for parent class \Bitrix\Sale\Internals\EntityCollection

Method	Description	Available from version
clearCollection	Deletes all collection items.
doFinalAction	Executes final actions.
getIndexById	Searches item in collection by ID and returns its internal index.
getItemById	Searches item in collection by ID and returns it.
getItemByIndex	Searches item in collection by internal index and returns it.
isAnyItemDeleted	Checks if a collection item was deleted.
isChanged	Checks if collection was updated. Returns true or false.
isClone	Checks if collection was cloned. Returns true or false.
verify	Verifies collection validly. Returns object \Bitrix\Sale\Result.

Methods for parent class \Bitrix\Sale\Internals\CollectionBase

Method	Description	Available from version
count	Returns number of object items.
current	Returns current item.
getIterator	Returns external iterator.
isEmpty	Checks collection for emptiness. When collection doesn't contain any items, returns true (otherwise, false).
key	Returns index for current collection item.
next	Moves collection selection to the next item.
offsetExists	Defines, if specified offset exists (key).
offsetGet	Returns specified offset (key).
offsetSet	Sets value for this offset.
offsetUnset	Resets offset value.
rewind	Rewinds selection to the first collection item.
valid	Checks, if collection contains valid items.