eCart function referance

Tutorial created by Jason Byrnes, WebAssist

Categories: eCart

0 ratings | Sign in to rate this tutorial | View comments

next section

Index

1. GetContent
   
2. SaveCart
   
3. BOF
   
4. ClearCart
   
5. ResetAll
   
6. DeleteFromCart
   
7. DisplayInfo
   
8. EOF
   
9. RulesInformation
   
10. Rules_EOF

next section

GetContent

GetContent()

Initialize the cart contents. should be used on nay page that includes the eCart object after the require_once line

<?php
//WA eCart Include
require_once("WA_eCart/eCart1_PHP.php");
?>
<?php
$eCart1->GetContent();
?>

next section

SaveCart

SaveCart()

Save the cart contents

$eCart1->SaveCart();

next section

BOF

BOF()


Returns true if the pointer is on the first line item, else returns false

$eCart1->BOF();

next section

ClearCart

ClearCart()

Remove all items from the cart

$eCart1->ClearCart();

next section

ResetAll

ResetAll()

Reset the Cart

$eCart1->ResetAll();

next section

DeleteFromCart

DeleteFromCart($index, $reIndex)


$index - array index of the item to remove
$reIndex - true or false to reindex the cart.

$eCart1->DeleteFromCart(1, true);

next section

DisplayInfo

DisplayInfo($ItemProperty)

Used to display a cart column value on the page:

echo($eCart1->DisplayInfo("Name"));

next section

EOF()

EOF()

$eCart1->EOF()

next section

RulesInformation

RulesInformation($theSet)

Returns an array of the rules defined for theSet parameter.

Parameters:
$theSet - can be "Charges", "Discounts", "tax", "Shipping"

$eCart1->RulesInformation("Discounts")

next section

Rules_EOF

Rules_EOF($theSet)

Returns true if the pointer is on the last rule for the selected set.

Parameters:
$theSet - can be "Charges", "Discounts", "Tax", "Shipping"

$eCart1->Rules_EOF("Tax");

next section

GetInfo

GetInfo($ItemID, $ItemProperty)

Returns the Item property for the Item ID that is passed.

Parameters:
$ItemID - ID for the item in the cart
$ItemProperty - name of the cart column value to return

$eCart1->GetInfo(3, "Quantity");

next section

GetItem

GetItem($ItemID)

returns an array of the properties for the specified item

Parameters:
$ItemID - The ID of the Item in the cart

$eCart1->GetItem(5);

next section

InCart

InCart($itemID)

returns true if the ID passed is in the cart, false if not

Parameters:
$itemID - ID for the Item to look for

$eCart1->InCart(3);

next section

IsEmpty

IsEmpty()

returns true if the cart is empty, false if there are items in the cart;

$eCart1->IsEmpty();

next section

Move

Move($modifier)

Move the cart pointer the specified number in the list of line items

Parameters:
$modifier - number of line item to move the pointer

$eCart1->Move(3);

next section

MoveFirst

MoveFirst()

move the cart pointer to the first item.

$eCart1->MoveFirst();

next section

MoveLast

MoveLast()

move the cart pointer to the last item:

$eCart1->MoveLast();

next section

MoveNext

MoveNext()

move the cart pointer to the next item:

$eCart1->MoveNext();

next section

MovePrevious

MovePrevious()

move the cart pointer to the previous item

$eCart1->MovePrevious()

next section

Rules_MoveNext

Rules_MoveNext($theSet)

move the cart pointer to the next rule in the specified set

Parameters:
$theSet - can be "Discounts, "Shipping", Tax", "Charges"

$eCart1->Rules_MoveNext("Shipping")

next section

Rules_MoveFirst

Rules_MoveFirst($theSet)

move the cart pointer to the First rule in the specified set

Parameters:
$theSet - can be "Discounts, "Shipping", Tax", "Charges"

$eCart1->Rules_MoveFirst("Discounts")

next section

ReIndexContent()

ReIndexContent()

Recreate the cart index

$eCart->ReIndexContent();

next section

TotalColumn

TotalColumn($ColumnName)

Returns the SubTotal of cart column for all items in the cart, used for total quantity as an example:

Parameters:
$ColumnName - the name of the column to calcualte subtotal for.

$eCart1->TotalColumn("Quantity")

next section

GetCharges

GetCharges()

Returns the Subtotal of all active Charges:

$eCart1->GetCharges();

next section

GetDiscounts

GetDiscounts()

$eCart1->GetDiscounts();

next section

GetTax

GetTax()

$eCart1->GetTax();

next section

GetShipping

GetShipping()

$eCart1->GetShipping();

next section

TotalRuleset

TotalRuleset($theSet)

Parameters:
$theSet - can be "Discounts", "Shipping", Tax", "Charges"

$eCart1->TotalRuleset("Discounts");

next section

GetRuleValueByName

GetRuleValueByName($theSet, $theName)

Parameters:
$theSet - can be "Discounts", "Shipping", Tax", "Charges"

$eCart1->GetRuleValueByName($theSet, $theName);

next section

RuleLooperName

RuleLooperName($theSet)

Parameters:
$theSet - can be "Discounts", "Shipping", Tax", "Charges"

$eCart1->RuleLooperName("Shipping");

next section

RuleLooperValue

RuleLooperValue($theSet)

Parameters:
$theSet - can be "Discounts", "Shipping", Tax", "Charges"

$eCart1->RuleLooperValue("Charges");

next section

ConditionalTotal

ConditionalTotal($ColumnName, $ConditionalColumn, $ConditionalValue)

$eCart1->ConditionalTotal("Quantity", "Name", "Widget A");

next section

GetTaxableTotal

GetTaxableTotal()

$eCart1->GetTaxableTotal();

next section

GetTaxedSubtotal

GetTaxedSubtotal()

$eCart1->GetTaxedSubtotal();

next section

GrandTotal

GrandTotal()

$eCart1->GrandTotal();

next section

DeleteZeroQuantity

DeleteZeroQuantity()

$eCart1->DeleteZeroQuantity();

next section

Session_SaveCart

Session_SaveCart()

$eCart1->Session_SaveCart();

next section

Session_GetContent

Session_GetContent()

$eCart1->Session_GetContent();

next section

Cookie_SaveCart

Cookie_SaveCart()

$eCart1->Cookie_SaveCart();

next section

Cookie_GetContent

Cookie_GetContent()

$eCart1->Cookie_GetContent();

next section

WA_eCart_WeightConversion

WA_eCart_WeightConversion($theWeight, $startUnits, $endUnits)

$eCart1->WA_eCart_WeightConversion($theWeight, $startUnits, $endUnits);

next section

WA_eCart_GetWeightFromPounds

WA_eCart_GetWeightFromPounds($lbsWeight, $endUnits)

$eCart1->WA_eCart_GetWeightFromPounds($lbsWeight, $endUnits);

next section

WA_eCart_GetGroupDecimalChars

WA_eCart_GetGroupDecimalChars($numDisplay)

$eCart1->WA_eCart_GetGroupDecimalChars($numDisplay);

next section

WA_eCart_DisplayMoney

WA_eCart_DisplayMoney($theObject, $theAmount)

WA_eCart_DisplayMoney(eCart1, "12.99")

next section

WA_eCart_DisplayWeight

WA_eCart_DisplayWeight($theObject, $theWeight)

$eCart1->IsEmpty();

next section

WA_eCart_DisplayNumber

WA_eCart_DisplayNumber($theObject, $theNumber)

$eCart1->IsEmpty();

next section

WA_eCart_MaskOutput

WA_eCart_MaskOutput($tValue, $tMaskType, $tMaskArguments)

$eCart1->IsEmpty();

next section

WA_eCart_MaskNumber

WA_eCart_MaskNumber($theNumStr, $groupChar, $decimalChar, $forceDec, $numDec)

$eCart1->IsEmpty();

next section

WA_eCart_MaskWeightMoney

WA_eCart_MaskWeightMoney($theNumStr, $symbolStr, $leftOrRight, $groupChar, $decimalChar, $forceDec, $numDec)

$eCart1->IsEmpty();

next section

WA_eCart_MaskDate

WA_eCart_MaskDate($dateVar, $dateFormat, $timeFormat)

$eCart1->IsEmpty();

next section

WA_eCart_FormatNumber

WA_eCart_FormatNumber($theNumStr, $forceDec, $numDec)

$eCart1->IsEmpty();

next section

WA_RoundToDecimals

WA_RoundToDecimals($theNum, $theDecimals)

$eCart1->IsEmpty();

next section

WA_GetCountryName

WA_GetCountryName($countryCode)

$eCart1->IsEmpty();

next section

WAEC_findRecordMySQL

WAEC_findRecordMySQL($theRS, $theCol, $theVal)

$eCart1->IsEmpty();

next section

WA_isValidPayPal

WA_isValidPayPal()

$eCart1->IsEmpty();

next section

WAEC_getTimestamp

WAEC_getTimestamp()

$eCart1->IsEmpty();

siteToPageRel

siteToPageRel($theSite)

$eCart1->IsEmpty();

Reviews and comments

Comments will be sent to the author of this tutorial and may not be answered immediately. For general help from WebAssist, please visit technical support.

0 ratings | Sign in to rate this tutorial