woocommerce/includes/class-wc-customer.php

<?php
include_once( 'legacy/class-wc-legacy-customer.php' );

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * The WooCommerce customer class handles storage of the current customer's data, such as location.
 *
 * @class    WC_Customer
 * @version  2.7.0
 * @package  WooCommerce/Classes
 * @category Class
 * @author   WooThemes
 */
class WC_Customer extends WC_Legacy_Customer implements WC_Data {

	/**
	 * Stores customer data.
	 * @var array
	 */
	protected $_data = array(
		'id'				  => 0,
		'email'               => '',
		'username'            => '', // read only on updates
		'password'            => '', // write only
		'postcode'            => '',
		'city'                => '',
		'address_1'           => '',
		'address_2'           => '',
		'state'               => '',
		'country'             => '',
		'shipping_postcode'   => '',
		'shipping_city'       => '',
		'shipping_address_1'  => '',
		'shipping_address_2'  => '',
		'shipping_state'      => '',
		'shipping_country'    => '',
		'is_paying_customer'  => false,
		'is_vat_exempt'       => false, // session only.
		'calculated_shipping' => false, // session only
	);

	/**
	 * Keys which are also stored in a session (so we can make sure they get updated...)
	 * @var array
	 */
	protected $_session_keys = array(
		'postcode', 'city', 'address_1', 'address_2', 'state', 'country',
		'shipping_postcode', 'shipping_city', 'shipping_address_1', 'shipping_address_2',
		'shipping_state', 'shipping_country', 'is_vat_exempt', 'calculated_shipping',
	);

	/**
	 * Was data changed in the database for this class?
	 * @var boolean
	 */
	protected $_changed = false;

	/**
	 * If some of the customer information is loaded by session (instead of just from the DB).
	 * @var boolean
	 */
	protected $_from_session = false;

	/**
	 * WC_Customer can also return an object for a logged out user (session).
	 * $_is_user will be false in this case. It will be true for all other cases
	 * (logged in users or getting a WC_Customer for another object)
	 * @var boolean
	 */
	protected $_is_user = false;

	/**
	 * Load customer data based on how WC_Customer is called.
	 * @param mixed $customer WC_Customer object or customer ID is accepted.
	 * if $customer is null, you can build a new WC_Customer object. If it's empty, some
	 * data will be pulled from the session for the current user/customer.
	 */
	public function __construct( $customer = '' ) {
		if ( $customer instanceof WC_Customer ) {
			$this->_is_user = true;
			$this->read( absint( $customer->get_id() ) );
		} else if ( is_numeric( $customer ) ) {
			$this->_is_user = true;
			$this->read( $customer );
		} else if ( is_null( $customer ) ) {
			$this->_is_user = true; // not an existing user yet, we are creating a new one
		} else if ( empty( $customer ) ) {
			$this->_from_session = true;
			if ( is_user_logged_in() ) {
				$this->_is_user = true;
				$this->read( get_current_user_id() );
			} else {
				$this->read( WC()->session->get_customer_id() );
			}
		}

		if ( $this->_from_session ) {
			add_action( 'shutdown', array( $this, 'save_session_if_changed' ), 10 );
		}
	}

	/**
	 * Saves customer information to the current session if any data changed.
	 * @since 2.7.0
	 */
	public function save_session_if_changed() {
		if ( $this->_changed ) {
			$this->save_to_session();
		}
	}

	/*
	 |--------------------------------------------------------------------------
	 | Getters
	 |--------------------------------------------------------------------------
	 | Methods for getting data from the customer object.
	 */

	/**
	 * Return a customer's user ID. If the current customer is logged out, this will be a session key.
	 * @since 2.7.0
	 * @return mixed
	 */
	public function get_id() {
		return $this->_data['id'];
	}

	/**
	 * Return the customer's username.
	 * @since 2.7.0
	 * @return string
	 */
	public function get_username() {
		return $this->_data['username'];
	}

	/**
	 * Return the customer's email.
	 * @since 2.7.0
	 * @return string
	 */
	public function get_email() {
		return sanitize_email( $this->_data['email'] );
	}

	/**
	 * Gets customer postcode.
	 * @return string
	 */
	public function get_postcode() {
		return wc_format_postcode( $this->_data['postcode'], $this->get_country() );
	}

	/**
	 * Get customer city.
	 * @return string
	 */
	public function get_city() {
		return $this->_data['city'];
	}

	/**
	 * Get customer address.
	 * @return string
	 */
	public function get_address() {
		return $this->_data['address_1'];
	}

	/**
	 * Get customer's second address.
	 * @return string
	 */
	public function get_address_2() {
		return $this->_data['address_2'];
	}

	/**
	 * Get customer state.
	 * @return string
	 */
	public function get_state() {
		return $this->_data['state'];
	}

	/**
	 * Get customer country.
	 * @return string
	 */
	public function get_country() {
		return $this->_data['country'];
	}

	/**
	 * Get customer's shipping state.
	 * @return string
	 */
	public function get_shipping_state() {
		return $this->_data['shipping_state'];
	}

	/**
	 * Get customer's shipping country.
	 * @return string
	 */
	public function get_shipping_country() {
		return $this->_data['shipping_country'];
	}

	/**
	 * Get customer's shipping postcode.
	 * @return string
	 */
	public function get_shipping_postcode() {
		return wc_format_postcode( $this->_data['shipping_postcode'], $this->get_shipping_country() );
	}

	/**
	 * Get customer's shipping city.
	 * @return string
	 */
	public function get_shipping_city() {
		return $this->_data['shipping_city'];
	}

	/**
	 * Get customer's shipping address.
	 * @return string
	 */
	public function get_shipping_address() {
		return $this->_data['shipping_address_1'];
	}

	/**
	 * Get customer's second shipping address.
	 * @return string
	 */
	public function get_shipping_address_2() {
		return $this->_data['shipping_address_2'];
	}

	/**
	 * Get if customer is VAT exempt?
	 * @since 2.7.0
	 * @return bool
	 */
	public function get_is_vat_exempt() {
		return ( ! empty( $this->_data['is_vat_exempt'] ) ) ? true : false;
	}

	/**
	 * Has customer calculated shipping?
	 * @return bool
	 */
	public function get_calculated_shipping() {
		return ! empty( $this->_data['calculated_shipping'] );
	}

	/**
	 * Get taxable address.
	 * @return array
	 */
	public function get_taxable_address() {
		$tax_based_on = get_option( 'woocommerce_tax_based_on' );

		// Check shipping method at this point to see if we need special handling
		if ( true === (bool) apply_filters( 'woocommerce_apply_base_tax_for_local_pickup', true ) && WC()->cart->needs_shipping() && sizeof( array_intersect( WC()->session->get( 'chosen_shipping_methods', array() ), apply_filters( 'woocommerce_local_pickup_methods', array( 'legacy_local_pickup', 'local_pickup' ) ) ) ) > 0 ) {
			$tax_based_on = 'base';
		}

		if ( 'base' === $tax_based_on ) {
			$country  = WC()->countries->get_base_country();
			$state    = WC()->countries->get_base_state();
			$postcode = WC()->countries->get_base_postcode();
			$city     = WC()->countries->get_base_city();
		} elseif ( 'billing' === $tax_based_on ) {
			$country  = $this->get_country();
			$state    = $this->get_state();
			$postcode = $this->get_postcode();
			$city     = $this->get_city();
		} else {
			$country  = $this->get_shipping_country();
			$state    = $this->get_shipping_state();
			$postcode = $this->get_shipping_postcode();
			$city     = $this->get_shipping_city();
		}

		return apply_filters( 'woocommerce_customer_taxable_address', array( $country, $state, $postcode, $city ) );
	}

	/**
	 * Gets a customer's downloadable products.
	 * @return array Array of downloadable products
	 */
	public function get_downloadable_products() {
		$downloads = array();
		if ( $this->_is_user ) {
			$downloads = wc_get_customer_available_downloads( $this->get_id() );
		}
		return apply_filters( 'woocommerce_customer_get_downloadable_products', $downloads );
	}

	/**
	 * Is the user a paying customer?
	 * @since 2.7.0
	 * @return bool
	 */
	function get_is_paying_customer() {
		return (bool) $this->_data['is_paying_customer'];
	}

	/**
	 * Get all class data in array format.
	 * @since 2.7.0
	 * @return array
	 */
	public function get_data() {
		return $this->_data;
	}

	/*
	|--------------------------------------------------------------------------
	| Setters
	|--------------------------------------------------------------------------
	| Functions for setting customer data. These should not update anything in the
	| database itself and should only change what is stored in the class
	| object.
	*/

	/**
	 * Set customer's username.
	 * @since 2.7.0
	 * @param string $username
	 */
	public function set_username( $username ) {
		$this->_data['username'] = $username;
	}

	/**
	 * Set customer's email.
	 * @since 2.7.0
	 * @param string $email
	 */
	public function set_email( $email ) {
		$this->_data['email'] = sanitize_email( $email );
	}

	/**
	 * Set customer's password.
	 * @since 2.7.0
	 * @param string $password
	 */
	public function set_password( $password ) {
		$this->_data['password'] = wc_clean( $password );
	}

	/**
	 * Set customer address to match shop base address.
	 * @since 2.7.0
	 */
	public function set_address_to_base() {
		$base = wc_get_customer_default_location();
		$this->_data['country']  = $base['country'];
		$this->_data['state']    = $base['state'];
		$this->_data['postcode'] = '';
		$this->_data['city']     = '';
	}

	/**
	 * Set customer shipping address to base address.
	 * @since 2.7.0
	 */
	public function set_address_shipping_to_base() {
		$base = wc_get_customer_default_location();
		$this->_data['shipping_country']  = $base['country'];
		$this->_data['shipping_state']    = $base['state'];
		$this->_data['shipping_postcode'] = '';
		$this->_data['shipping_city']     = '';
	}

	/**
	 * Sets all shipping info at once.
	 * @param string $country
	 * @param string $state
	 * @param string $postcode
	 * @param string $city
	 */
	public function set_shipping_location( $country, $state = '', $postcode = '', $city = '' ) {
		$this->_data['shipping_country']  = $country;
		$this->_data['shipping_state']    = $state;
		$this->_data['shipping_postcode'] = $postcode;
		$this->_data['shipping_city']     = $city;
	}

	/**
	 * Sets all address info at once.
	 * @param string $country
	 * @param string $state
	 * @param string $postcode
	 * @param string $city
	 */
	public function set_location( $country, $state, $postcode = '', $city = '' ) {
		$this->_data['country']  = $country;
		$this->_data['state']    = $state;
		$this->_data['postcode'] = $postcode;
		$this->_data['city']     = $city;
	}

	/**
	 * Set customer country.
	 * @param mixed $country
	 */
	public function set_country( $country ) {
		$this->_data['country'] = $country;
	}

	/**
	 * Set customer state.
	 * @param mixed $state
	 */
	public function set_state( $state ) {
		$this->_data['state'] = $state;
	}

	/**
	 * Sets customer postcode.
	 * @param mixed $postcode
	 */
	public function set_postcode( $postcode ) {
		$this->_data['postcode'] = $postcode;
	}

	/**
	 * Sets customer city.
	 * @param mixed $city
	 */
	public function set_city( $city ) {
		$this->_data['city'] = $city;
	}

	/**
	 * Set customer address.
	 * @param mixed $address
	 */
	public function set_address( $address ) {
		$this->_data['address_1'] = $address;
	}

	/**
	 * Set customer's second address.
	 * @param mixed $address
	 */
	public function set_address_2( $address ) {
		$this->_data['address_2'] = $address;
	}

	/**
	 * Set shipping country.
	 * @param string $country
	 */
	public function set_shipping_country( $country ) {
		$this->_data['shipping_country'] = $country;
	}

	/**
	 * Set shipping state.
	 * @param string $state
	 */
	public function set_shipping_state( $state ) {
		$this->_data['shipping_state'] = $state;
	}

	/**
	 * Set shipping postcode.
	 * @param string $postcode
	 */
	public function set_shipping_postcode( $postcode ) {
		$this->_data['shipping_postcode'] = $postcode;
	}

	/**
	 * Sets shipping city.
	 * @param string $city
	 */
	public function set_shipping_city( $city ) {
		$this->_data['shipping_city'] = $city;
	}

	/**
	 * Set shipping address.
	 * @param string $address
	 */
	public function set_shipping_address( $address ) {
		$this->_data['shipping_address_1'] = $address;
	}

	/**
	 * Set second shipping address.
	 * @param string $address
	 */
	public function set_shipping_address_2( $address ) {
		$this->_data['shipping_address_2'] = $address;
	}

	/**
	 * Set if customer has tax exemption.
	 * @param bool $is_vat_exempt
	 */
	public function set_is_vat_exempt( $is_vat_exempt ) {
		$this->_data['is_vat_exempt'] = $is_vat_exempt;
	}

	/**
	 * Calculated shipping?
	 * @param boolean $calculated
	 */
	public function set_calculated_shipping( $calculated = true ) {
		$this->_data['calculated_shipping'] = $calculated;
	}

	/**
	 * Set if the user a paying customer.
	 * @since 2.7.0
	 * @param boolean $is_paying_customer
	 */
	function set_is_paying_customer( $is_paying_customer ) {
		$this->_data['is_paying_customer'] = (bool) $is_paying_customer;
	}

	/*
	|--------------------------------------------------------------------------
	| Other methods
	|--------------------------------------------------------------------------
	| Other functions for interacting with customers.
	*/

	/**
	 * Is customer outside base country (for tax purposes)?
	 * @return bool
	 */
	public function is_customer_outside_base() {
		list( $country, $state ) = $this->get_taxable_address();
		if ( $country ) {
			$default = wc_get_base_location();
			if ( $default['country'] !== $country ) {
				return true;
			}
			if ( $default['state'] && $default['state'] !== $state ) {
				return true;
			}
		}
		return false;
	}

	/*
	 |--------------------------------------------------------------------------
	 | CRUD methods
	 |--------------------------------------------------------------------------
	 | Methods which create, read, update and delete from the database.
	 |
	 | A save method is included for convenience (chooses update or create based
	 | on if the order exists yet).
	 */

	 /**
	  * Create a customer.
	  * @since 2.7.0.
	  */
	public function create() {
		$customer_id = wc_create_new_customer( $this->get_email(), $this->get_username(), $this->_data['password'] );
		if ( $customer_id ) {
			$this->_data['id'] = $customer_id;
			update_user_meta( $this->get_id(), 'billing_postcode', $this->get_postcode() );
			update_user_meta( $this->get_id(), 'billing_city', $this->get_city() );
			update_user_meta( $this->get_id(), 'billing_address_1', $this->get_address() );
			update_user_meta( $this->get_id(), 'billing_address_2', $this->get_address_2() );
			update_user_meta( $this->get_id(), 'billing_state', $this->get_state() );
			update_user_meta( $this->get_id(), 'billing_country', $this->get_country() );
			update_user_meta( $this->get_id(), 'shipping_postcode', $this->get_shipping_postcode() );
			update_user_meta( $this->get_id(), 'shipping_city', $this->get_shipping_city() );
			update_user_meta( $this->get_id(), 'shipping_address_1', $this->get_shipping_address() );
			update_user_meta( $this->get_id(), 'shipping_address_2', $this->get_shipping_address_2() );
			update_user_meta( $this->get_id(), 'shipping_state', $this->get_shipping_state() );
			update_user_meta( $this->get_id(), 'shipping_country', $this->get_shipping_country() );
			update_user_meta( $this->get_id(), 'paying_customer', $this->get_is_paying_customer() );
		}
	}

	/**
	 * Read a customer from the database.
	 * @since 2.7.0
	 * @param integer $id
	 */
	public function read( $id ) {
		$pull_from_db = true;
		if ( $this->_from_session ) {
			$data = (array) WC()->session->get( 'customer' );
			if ( ! empty( $data ) ) {
				$pull_from_db  = false;
				foreach ( $this->_session_keys as $session_key ) {
					$this->_data[ $session_key ] = $data[ $session_key ];
				}
			}
		}

		if ( $pull_from_db ) {
			foreach ( array_keys( $this->_data ) as $key ) {
				$meta_value = get_user_meta( $id, ( false === strstr( $key, 'shipping_' ) ? 'billing_' : '' ) . $key, true );
				$this->_data[ $key ] = $meta_value ? $meta_value : $this->_data[ $key ];
			}
		}

		if ( $this->_is_user ) {
			$this->_data['is_paying_customer'] = get_user_meta( $id, 'paying_customer', true );
			$wp_user = new WP_User( $id );
			$this->_data['email']    = $wp_user->user_email;
			$this->_data['username'] = $wp_user->user_login;
		}

		$this->_data['id'] = $id;

		// Set some defaults if some of our values are still not set.
		if ( empty( $this->_data['country'] ) ) {
			$this->_data['country'] = $this->get_default_country();
		}

		if ( empty( $this->_data['shipping_country'] ) ) {
			$this->_data['shipping_country'] = $this->_data['country'];
		}

		if ( empty( $this->_data['state'] ) ) {
			$this->_data['state'] = $this->get_default_state();
		}

		if ( empty( $this->_data['shipping_state'] ) ) {
			$this->_data['shipping_state'] = $this->_data['state'];
		}

		unset( $this->_data['password'] ); // password is write only, never ever read it

		error_log( 'read' );
		error_log( print_r ( $this->get_id(), 1 ) );
		error_log( print_r ( $this->_data, 1 ) );
	}

	/**
	 * Update a customer.
	 * @since 2.7.0
	 */
	public function update() {
		$customer_ID = $this->get_id();

		wp_update_user( array( 'ID' => $customer_ID, 'user_email' => $this->get_email() ) );
		// Only update password if a new one was set with set_password
		if ( isset( $this->_data['password'] ) ) {
			wp_update_user( array( 'ID' => $customer_ID, 'user_pass' => $this->_data['password'] ) ) );
		}

		update_user_meta( $this->get_id(), 'billing_postcode', $this->get_postcode() );
		update_user_meta( $this->get_id(), 'billing_city', $this->get_city() );
		update_user_meta( $this->get_id(), 'billing_address_1', $this->get_address() );
		update_user_meta( $this->get_id(), 'billing_address_2', $this->get_address_2() );
		update_user_meta( $this->get_id(), 'billing_state', $this->get_state() );
		update_user_meta( $this->get_id(), 'billing_country', $this->get_country() );
		update_user_meta( $this->get_id(), 'shipping_postcode', $this->get_shipping_postcode() );
		update_user_meta( $this->get_id(), 'shipping_city', $this->get_shipping_city() );
		update_user_meta( $this->get_id(), 'shipping_address_1', $this->get_shipping_address() );
		update_user_meta( $this->get_id(), 'shipping_address_2', $this->get_shipping_address_2() );
		update_user_meta( $this->get_id(), 'shipping_state', $this->get_shipping_state() );
		update_user_meta( $this->get_id(), 'shipping_country', $this->get_shipping_country() );
		update_user_meta( $this->get_id(), 'paying_customer', $this->get_is_paying_customer() );
	}

	/**
	 * Delete a customer.
	 * @since 2.7.0
	 */
	public function delete() {
		if ( ! $this->get_id() ) {
			return;
		}
		wp_delete_user( $this->get_id() );
	}

	/**
	 * Save data (either create or update depending on if we are working on an existing customer).
	 * @since 2.7.0
	 */
	public function save() {
		if ( ! $this->_is_user ) {
			$this->create();
		} else {
			if ( ! $this->get_id() ) {
				$this->create();
			} else {
				$this->update();
			}
		}
	}

	/**
	 * Saves data to the session only (does not overwrite DB values).
	 * @since 2.7.0
	 */
	public function save_to_session() {
		if ( ! $this->_from_session ) {
			return;
		}
		$data = array();
		foreach ( $this->_session_keys as $session_key ) {
			$data[ $session_key ] = $this->_data[ $session_key ];
		}
		WC()->session->set( 'customer', $data );
	}

}