PHP Interface LukePOLO\LaraCart\Contracts\LaraCartContract

Mostra file Open project: lukepolo/laracart

Public Methods

Method Description
add ( $itemID, null $name = null, integer $qty = 1, string $price = '0.00', array $options = [], boolean | false $taxable = true, boolean | false $lineItem = false ) : CartItem Creates a CartItem and then adds it to cart.
addCoupon ( LukePOLO\LaraCart\Contracts\CouponContract $coupon ) Applies a coupon to the cart.
addFee ( $name, $amount, boolean | false $taxable = false, array $options = [] ) Allows to charge for additional fees that may or may not be taxable ex - service fee , delivery fee, tips.
addItem ( CartItem $cartItem ) : CartItem Adds the cartItem into the cart session.
addLine ( string | integer $itemID, null $name = null, integer $qty = 1, string $price = '0.00', array $options = [], boolean | true $taxable = true ) : CartItem Creates a CartItem and then adds it to cart.
count ( boolean $withItemQty = true ) : integer Get the count based on qty, or number of unique items.
destroyCart ( ) Completely destroys cart and anything associated with it.
emptyCart ( ) Empties the carts items.
feeTotals ( boolean $format = true ) : string Gets all the fee totals.
findCoupon ( $code ) : mixed Finds a specific coupon in the cart.
formatMoney ( $number, $locale = null, $internationalFormat = null, $format = true ) : string Formats the number into a money format based on the locale and international formats.
get ( string $instance = 'default' ) Gets the instance in the session.
getAttribute ( $attribute, $defaultValue = null ) : mixed Gets an an attribute from the cart.
getAttributes ( ) : mixed Gets all the carts attributes.
getCoupons ( ) : array Gets the coupons for the current cart.
getFee ( $name ) : mixed Gets a speific fee from the fees array.
getFees ( ) : mixed Getes all the fees on the cart object.
getItem ( $itemHash ) : CartItem | null Finds a cartItem based on the itemHash.
getItems ( ) : array Gets all the items within the cart.
removeAttribute ( $attribute ) Removes an attribute from the cart.
removeCoupon ( $code ) Removes a coupon in the cart.
removeFee ( $name ) Reemoves a fee from the fee array.
removeItem ( $itemHash ) Removes a CartItem based on the itemHash.
setAttribute ( $attribute, $value ) Adds an Attribute to the cart.
setInstance ( string $instance = 'default' ) : LaraCart Sets and Gets the instance of the cart in the session we should be using.
subTotal ( boolean $format = true, boolean $withDiscount = true ) : string Gets the subtotal of the cart with or without tax.
taxTotal ( boolean | true $format = true ) : string Gets the total tax for the cart.
total ( boolean $format = true, boolean $withDiscount = true ) : string Gets the total of the cart with or without tax.
totalDiscount ( boolean | true $format = true ) : integer | string Gets the total amount discounted.
update ( ) Updates cart session.
updateItem ( $itemHash, $key, $value ) : CartItem Updates an items attributes.

Method Details

add() public method

Creates a CartItem and then adds it to cart.
public add ( $itemID, null $name = null, integer $qty = 1, string $price = '0.00', array $options = [], boolean | false $taxable = true, boolean | false $lineItem = false ) : CartItem
$itemID
$name null
$qty integer
$price string
$options array
$taxable boolean | false
$lineItem boolean | false
return LukePOLO\LaraCart\CartItem

addCoupon() public method

Applies a coupon to the cart.
public addCoupon ( LukePOLO\LaraCart\Contracts\CouponContract $coupon )
$coupon LukePOLO\LaraCart\Contracts\CouponContract

addFee() public method

Allows to charge for additional fees that may or may not be taxable ex - service fee , delivery fee, tips.
public addFee ( $name, $amount, boolean | false $taxable = false, array $options = [] )
$name
$amount
$taxable boolean | false
$options array

addItem() public method

Adds the cartItem into the cart session.
public addItem ( CartItem $cartItem ) : CartItem
$cartItem LukePOLO\LaraCart\CartItem
return LukePOLO\LaraCart\CartItem

addLine() public method

Creates a CartItem and then adds it to cart.
public addLine ( string | integer $itemID, null $name = null, integer $qty = 1, string $price = '0.00', array $options = [], boolean | true $taxable = true ) : CartItem
$itemID string | integer
$name null
$qty integer
$price string
$options array
$taxable boolean | true
return LukePOLO\LaraCart\CartItem

count() public method

Get the count based on qty, or number of unique items.
public count ( boolean $withItemQty = true ) : integer
$withItemQty boolean
return integer

destroyCart() public method

Completely destroys cart and anything associated with it.
public destroyCart ( )

emptyCart() public method

Empties the carts items.
public emptyCart ( )

feeTotals() public method

Gets all the fee totals.
public feeTotals ( boolean $format = true ) : string
$format boolean
return string

findCoupon() public method

Finds a specific coupon in the cart.
public findCoupon ( $code ) : mixed
$code
return mixed

formatMoney() public static method

Formats the number into a money format based on the locale and international formats.
public static formatMoney ( $number, $locale = null, $internationalFormat = null, $format = true ) : string
$number
$locale
$internationalFormat
$format
return string

get() public method

Gets the instance in the session.
public get ( string $instance = 'default' )
$instance string

getAttribute() public method

Gets an an attribute from the cart.
public getAttribute ( $attribute, $defaultValue = null ) : mixed
$attribute
$defaultValue
return mixed

getAttributes() public method

Gets all the carts attributes.
public getAttributes ( ) : mixed
return mixed

getCoupons() public method

Gets the coupons for the current cart.
public getCoupons ( ) : array
return array

getFee() public method

Gets a speific fee from the fees array.
public getFee ( $name ) : mixed
$name
return mixed

getFees() public method

Getes all the fees on the cart object.
public getFees ( ) : mixed
return mixed

getItem() public method

Finds a cartItem based on the itemHash.
public getItem ( $itemHash ) : CartItem | null
$itemHash
return LukePOLO\LaraCart\CartItem | null | null

getItems() public method

Gets all the items within the cart.
public getItems ( ) : array
return array

removeAttribute() public method

Removes an attribute from the cart.
public removeAttribute ( $attribute )
$attribute

removeCoupon() public method

Removes a coupon in the cart.
public removeCoupon ( $code )
$code

removeFee() public method

Reemoves a fee from the fee array.
public removeFee ( $name )
$name

removeItem() public method

Removes a CartItem based on the itemHash.
public removeItem ( $itemHash )
$itemHash

setAttribute() public method

Adds an Attribute to the cart.
public setAttribute ( $attribute, $value )
$attribute
$value

setInstance() public method

Sets and Gets the instance of the cart in the session we should be using.
public setInstance ( string $instance = 'default' ) : LaraCart
$instance string
return LukePOLO\LaraCart\LaraCart

subTotal() public method

Gets the subtotal of the cart with or without tax.
public subTotal ( boolean $format = true, boolean $withDiscount = true ) : string
$format boolean
$withDiscount boolean
return string

taxTotal() public method

Gets the total tax for the cart.
public taxTotal ( boolean | true $format = true ) : string
$format boolean | true
return string

total() public method

Gets the total of the cart with or without tax.
public total ( boolean $format = true, boolean $withDiscount = true ) : string
$format boolean
$withDiscount boolean
return string

totalDiscount() public method

Gets the total amount discounted.
public totalDiscount ( boolean | true $format = true ) : integer | string
$format boolean | true
return integer | string

update() public method

Updates cart session.
public update ( )

updateItem() public method

Updates an items attributes.
public updateItem ( $itemHash, $key, $value ) : CartItem
$itemHash
$key
$value
return LukePOLO\LaraCart\CartItem