The «Magento_Customer/js/model/customer» JavaScript object interface

dmitrii_fediuk · April 14, 2016, 11:04am

Context: How to get the customer’s data on the frontend checkout page’s client side (with JavaScript) using the «Magento_Customer/js/model/customer» object?

`customerData` property

`customerDetails` property

It is always empty.

`isLoggedIn()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L15-L15


var isLoggedIn = ko.observable(window.isCustomerLoggedIn),

`getBillingAddressList()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L31-L33


getBillingAddressList: function () {
    return addressList();
},

It is never used.

`getShippingAddressList()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L34-L36


getShippingAddressList: function () {
    return addressList();
},

It is never used.

`setDetails()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L37-L41


setDetails: function (fieldName, value) {
    if (fieldName) {
        this.customerDetails[fieldName] = value;
    }
},

It is never used.

`getDetails()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L42-L51


getDetails: function (fieldName) {
    if (fieldName) {
        if (this.customerDetails.hasOwnProperty(fieldName)) {
            return this.customerDetails[fieldName];
        }
        return undefined;
    } else {
        return this.customerDetails;
    }
},

It is never used.

`addCustomerAddress()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L52-L85


addCustomerAddress: function (address) {
    var fields = [
            'customer_id', 'country_id', 'street', 'company', 'telephone', 'fax', 'postcode', 'city',
            'firstname', 'lastname', 'middlename', 'prefix', 'suffix', 'vat_id', 'default_billing',
            'default_shipping'
        ],
        customerAddress = {},
        hasAddress = 0,
        existingAddress;


    if (!this.customerData.addresses) {
        this.customerData.addresses = [];
    }


    customerAddress = _.pick(address, fields);
    if (address.hasOwnProperty('region_id')) {
        customerAddress.region = {
            region_id: address.region_id,
            region: address.region
        };
    }
    for (existingAddress in this.customerData.addresses) {
        if (this.customerData.addresses.hasOwnProperty(existingAddress)) {
            if (_.isEqual(this.customerData.addresses[existingAddress], customerAddress)) {
                hasAddress = existingAddress;
                break;
            }
        }
    }
    if (hasAddress === 0) {
        return this.customerData.addresses.push(customerAddress) - 1;
    }
    return hasAddress;
},

It is never used.

`setAddressAsDefaultBilling()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L86-L92


setAddressAsDefaultBilling: function (addressId) {
    if (this.customerData.addresses[addressId]) {
        this.customerData.addresses[addressId].default_billing = 1;
        return true;
    }
    return false;
},

It is never used.

`setAddressAsDefaultShipping()` method

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Customer/view/frontend/web/js/model/customer.js#L93-L99


setAddressAsDefaultShipping: function (addressId) {
    if (this.customerData.addresses[addressId]) {
        this.customerData.addresses[addressId].default_shipping = 1;
        return true;
    }
    return false;
}

It is never used.

dmitrii_fediuk · April 15, 2016, 8:53am

customerData property

customerDetails property

isLoggedIn() method

getBillingAddressList() method

getShippingAddressList() method

setDetails() method

getDetails() method

addCustomerAddress() method

setAddressAsDefaultBilling() method

setAddressAsDefaultShipping() method

`customerData` property

`customerDetails` property

`isLoggedIn()` method

`getBillingAddressList()` method

`getShippingAddressList()` method

`setDetails()` method

`getDetails()` method

`addCustomerAddress()` method

`setAddressAsDefaultBilling()` method

`setAddressAsDefaultShipping()` method