The «Magento_Checkout/js/checkout-data» JavaScript object interface and its implementation

dmitry_fedyuk · April 17, 2016, 12:06pm

Context:

How is the Magento_Checkout/js/checkout-data object implemented and used?
How to get the checkout data on the frontend checkout page’s client side (with JavaScript)?

setSelectedShippingAddress() method

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L41-L45


setSelectedShippingAddress: function (data) {
    var obj = getData();
    obj.selectedShippingAddress = data;
    saveData(obj);
},

getSelectedShippingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L47-L49


getSelectedShippingAddress: function () {
    return getData().selectedShippingAddress;
},

setShippingAddressFromData() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L51-L55


setShippingAddressFromData: function (data) {
    var obj = getData();
    obj.shippingAddressFromData = data;
    saveData(obj);
},

getShippingAddressFromData() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L57-L59


getShippingAddressFromData: function () {
    return getData().shippingAddressFromData;
},

setNewCustomerShippingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L61-L65


setNewCustomerShippingAddress: function (data) {
    var obj = getData();
    obj.newCustomerShippingAddress = data;
    saveData(obj);
},

getNewCustomerShippingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L67-L69


getNewCustomerShippingAddress: function () {
    return getData().newCustomerShippingAddress;
},

setSelectedShippingRate() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L71-L75


setSelectedShippingRate: function (data) {
    var obj = getData();
    obj.selectedShippingRate = data;
    saveData(obj);
},

getSelectedShippingRate() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L77-L79


getSelectedShippingRate: function() {
    return getData().selectedShippingRate;
},

setSelectedPaymentMethod() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L81-L85


setSelectedPaymentMethod: function (data) {
    var obj = getData();
    obj.selectedPaymentMethod = data;
    saveData(obj);
},

getSelectedPaymentMethod() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L87-L89


getSelectedPaymentMethod: function() {
    return getData().selectedPaymentMethod;
},

setSelectedBillingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L91-L95


setSelectedBillingAddress: function (data) {
    var obj = getData();
    obj.selectedBillingAddress = data;
    saveData(obj);
},

getSelectedBillingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L97-L99


getSelectedBillingAddress: function () {
    return getData().selectedBillingAddress;
},

setBillingAddressFromData() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L101-L105


setBillingAddressFromData: function (data) {
    var obj = getData();
    obj.billingAddressFromData = data;
    saveData(obj);
},

getBillingAddressFromData() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L107-L109


getBillingAddressFromData: function () {
    return getData().billingAddressFromData;
},

setNewCustomerBillingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L111-L115


setNewCustomerBillingAddress: function (data) {
    var obj = getData();
    obj.newCustomerBillingAddress = data;
    saveData(obj);
},

getNewCustomerBillingAddress() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L117-L119


getNewCustomerBillingAddress: function () {
    return getData().newCustomerBillingAddress;
},

getValidatedEmailValue() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L121-L124


getValidatedEmailValue: function () {
    var obj = getData();
    return (obj.validatedEmailValue) ? obj.validatedEmailValue : '';
},

Details: What is the difference between «Magento_Checkout/js/checkout-data»'s getValidatedEmailValue() and getInputFieldEmailValue() methods?

setValidatedEmailValue() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L126-L130


setValidatedEmailValue: function (email) {
    var obj = getData();
    obj.validatedEmailValue = email;
    saveData(obj);
},

Details: How are the Magento_Checkout/js/checkout-data's setValidatedEmailValue() and setInputFieldEmailValue() methods implemeted and used?

getInputFieldEmailValue() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L132-L135


getInputFieldEmailValue: function () {
    var obj = getData();
    return (obj.inputFieldEmailValue) ? obj.inputFieldEmailValue : '';
},

Details: What is the difference between «Magento_Checkout/js/checkout-data»'s getValidatedEmailValue() and getInputFieldEmailValue() methods?

setInputFieldEmailValue() method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js#L137-L141


setInputFieldEmailValue: function (email) {
    var obj = getData();
    obj.inputFieldEmailValue = email;
    saveData(obj);
}

Details: How are the Magento_Checkout/js/checkout-data's setValidatedEmailValue() and setInputFieldEmailValue() methods implemeted and used?

dmitry_fedyuk · April 17, 2016, 12:09pm