woocommerce/classes/class-wc-customer.php

<?php
/**
 * Customer
 *
 * The WooCommerce customer class handles storage of the current customer's data, such as location.
 *
 * @class 		WC_Customer
 * @version		1.6.4
 * @package		WooCommerce/Classes
 * @author 		WooThemes
 */
class WC_Customer {

	/** Stores customer data as an array */
	protected $_data;

	/**
	 * Constructor for the customer class loads the customer data.
	 *
	 * @access public
	 * @return void
	 */
	function __construct() {
		global $woocommerce;

		if ( empty( $woocommerce->session->customer ) ) {

			$default = apply_filters( 'woocommerce_customer_default_location', get_option( 'woocommerce_default_country' ) );

        	if ( strstr( $default, ':' ) ) {
        		list( $country, $state ) = explode( ':', $default );
        	} else {
        		$country = $default;
        		$state = '';
        	}

			$this->_data = array(
				'country' 				=> esc_html( $country ),
				'state' 				=> '',
				'postcode' 				=> '',
				'city'					=> '',
				'address' 				=> '',
				'address_2' 			=> '',
				'shipping_country' 		=> esc_html( $country ),
				'shipping_state' 		=> '',
				'shipping_postcode' 	=> '',
				'shipping_city'			=> '',
				'shipping_address'		=> '',
				'shipping_address_2'	=> '',
				'is_vat_exempt' 		=> false,
				'calculated_shipping'	=> false
			);

		} else {
			$this->_data = $woocommerce->session->customer;
		}

		// When leaving or ending page load, store data
    	add_action( 'shutdown', array( &$this, 'save_data' ), 10 );
	}

    /**
     * __get function.
     *
     * @access public
     * @param mixed $property
     * @return mixed
     */
    public function __get( $property ) {
        return isset( $this->_data[ $property ] ) ? $this->_data[ $property ] : null;
    }

    /**
     * __set function.
     *
     * @access public
     * @param mixed $property
     * @param mixed $value
     * @return void
     */
    public function __set( $property, $value ) {
        $this->_data[ $property ] = $value;
    }

	/**
	 * save_data function.
	 *
	 * @access public
	 * @return void
	 */
	function save_data() {
		global $woocommerce;
		$woocommerce->session->customer = $this->_data;
	}

	/**
	 * has_calculated_shipping function.
	 *
	 * @access public
	 * @return bool
	 */
	function has_calculated_shipping() {
		return ( ! empty( $this->_data['calculated_shipping'] ) && $this->_data['calculated_shipping'] ) ? true : false;
	}


	/**
	 * Set customer address to match shop base address.
	 *
	 * @access public
	 * @return void
	 */
	function set_to_base() {
		global $woocommerce;
		$default = apply_filters( 'woocommerce_customer_default_location', get_option('woocommerce_default_country') );
    	if ( strstr( $default, ':' ) ) {
    		list( $country, $state ) = explode( ':', $default );
    	} else {
    		$country = $default;
    		$state = '';
    	}
    	$this->_data['country'] = $country;
    	$this->_data['state'] = $state;
    	$this->_data['postcode'] = '';
    	$this->_data['city'] = '';
	}


	/**
	 * Set customer shipping address to base address.
	 *
	 * @access public
	 * @return void
	 */
	function set_shipping_to_base() {
		global $woocommerce;
		$default = get_option('woocommerce_default_country');
    	if ( strstr( $default, ':' ) ) {
    		list( $country, $state ) = explode( ':', $default );
    	} else {
    		$country = $default;
    		$state = '';
    	}
    	$this->_data['shipping_country'] = $country;
    	$this->_data['shipping_state'] = $state;
    	$this->_data['shipping_postcode'] = '';
    	$this->_data['shipping_city'] = '';
	}


	/**
	 * Is customer outside base country (for tax purposes)?
	 *
	 * @access public
	 * @return bool
	 */
	function is_customer_outside_base() {
		list( $country, $state, $postcode, $city ) = $this->get_taxable_address();

		if ( $country ) {

			$default = get_option('woocommerce_default_country');

        	if ( strstr( $default, ':' ) ) {
	    		list( $default_country, $default_state ) = explode( ':', $default );
	    	} else {
	    		$default_country = $default;
	    		$default_state = '';
	    	}

			if ( $default_country !== $country ) return true;
			if ( $default_state && $default_state !== $state ) return true;

		}
		return false;
	}


	/**
	 * Is customer VAT exempt?
	 *
	 * @access public
	 * @return bool
	 */
	function is_vat_exempt() {
		return ( isset( $this->_data['is_vat_exempt'] ) && $this->_data['is_vat_exempt'] ) ? true : false;
	}


	/**
	 * Gets the state from the current session.
	 *
	 * @access public
	 * @return string
	 */
	function get_state() {
		if ( isset( $this->_data['state'] ) ) return $this->_data['state'];
	}


	/**
	 * Gets the country from the current session
	 *
	 * @access public
	 * @return string
	 */
	function get_country() {
		if ( isset( $this->_data['country'] ) ) return $this->_data['country'];
	}


	/**
	 * Gets the postcode from the current session.
	 *
	 * @access public
	 * @return string
	 */
	function get_postcode() {
		global $woocommerce;
		$validation = $woocommerce->validation();
		if (isset($this->_data['postcode']) && $this->_data['postcode'] !== false) return $validation->format_postcode( $this->_data['postcode'], $this->get_country());
	}


	/**
	 * Get the city from the current session.
	 *
	 * @access public
	 * @return void
	 */
	function get_city() {
		if ( isset( $this->_data['city'] ) ) return $this->_data['city'];
	}

	/**
	 * Gets the address from the current session.
	 *
	 * @access public
	 * @return void
	 */
	function get_address() {
		if ( isset( $this->_data['address'] ) ) return $this->_data['address'];
	}

	/**
	 * Gets the address_2 from the current session.
	 *
	 * @access public
	 * @return void
	 */
	function get_address_2() {
		if ( isset( $this->_data['address_2'] ) ) return $this->_data['address_2'];
	}

	/**
	 * Gets the state from the current session.
	 *
	 * @access public
	 * @return string
	 */
	function get_shipping_state() {
		if ( isset( $this->_data['shipping_state'] ) ) return $this->_data['shipping_state'];
	}


	/**
	 * Gets the country from the current session.
	 *
	 * @access public
	 * @return string
	 */
	function get_shipping_country() {
		if ( isset( $this->_data['shipping_country'] ) ) return $this->_data['shipping_country'];
	}


	/**
	 * Gets the postcode from the current session.
	 *
	 * @access public
	 * @return string
	 */
	function get_shipping_postcode() {
		global $woocommerce;
		$validation = $woocommerce->validation();
		if (isset($this->_data['shipping_postcode'])) return $validation->format_postcode( $this->_data['shipping_postcode'], $this->get_shipping_country());
	}


	/**
	 * Gets the city from the current session.
	 *
	 * @access public
	 * @return void
	 */
	function get_shipping_city() {
		if ( isset( $this->_data['shipping_city'] ) ) return $this->_data['shipping_city'];
	}

	/**
	 * Gets the address from the current session.
	 *
	 * @access public
	 * @return void
	 */
	function get_shipping_address() {
		if ( isset( $this->_data['shipping_address'] ) ) return $this->_data['shipping_address'];
	}

	/**
	 * Gets the address_2 from the current session.
	 *
	 * @access public
	 * @return void
	 */
	function get_shipping_address_2() {
		if ( isset( $this->_data['shipping_address_2'] ) ) return $this->_data['shipping_address_2'];
	}

	/**
	 * get_taxable_address function.
	 *
	 * @access public
	 * @return void
	 */
	function get_taxable_address() {
		$tax_based_on = get_option( 'woocommerce_tax_based_on' );

		if ( $tax_based_on == 'base' ) {

			$default = get_option( 'woocommerce_default_country' );
	    	if ( strstr( $default, ':' ) ) {
	    		list( $country, $state ) = explode( ':', $default );
	    	} else {
	    		$country = $default;
	    		$state = '';
	    	}

			$postcode   = '';
			$city   	= '';

		} elseif ( $tax_based_on == 'billing' ) {

			$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 ) );
	}


	/**
	 * Sets session data for the location.
	 *
	 * @access public
	 * @param mixed $country
	 * @param mixed $state
	 * @param string $postcode (default: '')
	 * @param string $city (default: '')
	 * @return void
	 */
	function set_location( $country, $state, $postcode = '', $city = '' ) {
		$this->_data['country'] = $country;
		$this->_data['state'] = $state;
		$this->_data['postcode'] = $postcode;
		$this->_data['city'] = $city;
	}


	/**
	 * Sets session data for the country.
	 *
	 * @access public
	 * @param mixed $country
	 * @return void
	 */
	function set_country( $country ) {
		$this->_data['country'] = $country;
	}


	/**
	 * Sets session data for the state.
	 *
	 * @access public
	 * @param mixed $state
	 * @return void
	 */
	function set_state( $state ) {
		$this->_data['state'] = $state;
	}


	/**
	 * Sets session data for the postcode.
	 *
	 * @access public
	 * @param mixed $postcode
	 * @return void
	 */
	function set_postcode( $postcode ) {
		$this->_data['postcode'] = $postcode;
	}


	/**
	 * Sets session data for the city.
	 *
	 * @access public
	 * @param mixed $postcode
	 * @return void
	 */
	function set_city( $city ) {
		$this->_data['city'] = $city;
	}

	/**
	 * Sets session data for the address.
	 *
	 * @access public
	 * @param mixed $address
	 * @return void
	 */
	function set_address( $address ) {
		$this->_data['address'] = $address;
	}

	/**
	 * Sets session data for the address_2.
	 *
	 * @access public
	 * @param mixed $address_2
	 * @return void
	 */
	function set_address_2( $address_2 ) {
		$this->_data['address_2'] = $address_2;
	}

	/**
	 * Sets session data for the location.
	 *
	 * @access public
	 * @param mixed $country
	 * @param string $state (default: '')
	 * @param string $postcode (default: '')
	 * @param string $city (default: '')
	 * @return void
	 */
	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 session data for the country.
	 *
	 * @access public
	 * @param mixed $country
	 * @return void
	 */
	function set_shipping_country( $country ) {
		$this->_data['shipping_country'] = $country;
	}


	/**
	 * Sets session data for the state.
	 *
	 * @access public
	 * @param mixed $state
	 * @return void
	 */
	function set_shipping_state( $state ) {
		$this->_data['shipping_state'] = $state;
	}


	/**
	 * Sets session data for the postcode.
	 *
	 * @access public
	 * @param mixed $postcode
	 * @return void
	 */
	function set_shipping_postcode( $postcode ) {
		$this->_data['shipping_postcode'] = $postcode;
	}


	/**
	 * Sets session data for the city.
	 *
	 * @access public
	 * @param mixed $postcode
	 * @return void
	 */
	function set_shipping_city( $city ) {
		$this->_data['shipping_city'] = $city;
	}

	/**
	 * Sets session data for the address.
	 *
	 * @access public
	 * @param mixed $address
	 * @return void
	 */
	function set_shipping_address( $address ) {
		$this->_data['shipping_address'] = $address;
	}

	/**
	 * Sets session data for the address_2.
	 *
	 * @access public
	 * @param mixed $address_2
	 * @return void
	 */
	function set_shipping_address_2( $address_2 ) {
		$this->_data['shipping_address_2'] = $address_2;
	}


	/**
	 * Sets session data for the tax exemption.
	 *
	 * @access public
	 * @param mixed $is_vat_exempt
	 * @return void
	 */
	function set_is_vat_exempt( $is_vat_exempt ) {
		$this->_data['is_vat_exempt'] = $is_vat_exempt;
	}


	/**
	 * calculated_shipping function.
	 *
	 * @access public
	 * @param mixed $calculated
	 * @return void
	 */
	function calculated_shipping( $calculated = true ) {
		$this->_data['calculated_shipping'] = $calculated;
	}


	/**
	 * Gets a user's downloadable products if they are logged in.
	 *
	 * @access public
	 * @return array Array of downloadable products
	 */
	function get_downloadable_products() {
		global $wpdb, $woocommerce;

		$downloads = array();

		if ( is_user_logged_in() ) :

			$user_info = get_userdata( get_current_user_id() );

			$results = $wpdb->get_results( $wpdb->prepare("SELECT * FROM ".$wpdb->prefix."woocommerce_downloadable_product_permissions WHERE user_id = '%s' ORDER BY order_id, product_id, download_id", get_current_user_id()) );

			$_product = null;
			$order = null;
			$file_number = 0;
			if ($results) foreach ($results as $result) :

				if ($result->order_id>0) :

					if ( ! $order || $order->id != $result->order_id ) {
						// new order
						$order = new WC_Order( $result->order_id );
						$_product = null;
					}

					// order exists and downloads permitted?
					if ( ! $order->id || ! $order->is_download_permitted() || $order->status != 'publish' ) continue;

					if ( ! $_product || $_product->id != $result->product_id ) :
						// new product
						$file_number = 0;
						$_product = get_product( $result->product_id );
					endif;

					if ( ! $_product || ! $_product->exists() ) continue;

					if ( ! $_product->has_file( $result->download_id ) ) continue;

					// Download name will be 'Product Name' for products with a single downloadable file, and 'Product Name - File X' for products with multiple files
					$download_name = $_product->get_title() . ( $file_number > 0 ? ' &mdash; ' . sprintf( __( 'File %d', 'woocommerce' ), $file_number + 1 ) : '' );
					if ( $file_number == 1 ) $downloads[ count( $downloads ) - 1 ]['download_name'] .= ' &mdash; ' . sprintf( __( 'File %d', 'woocommerce' ), $file_number );

					$downloads[] = array(
						'download_url' => add_query_arg( array( 'download_file' => $result->product_id, 'order' => $result->order_key, 'email' => $result->user_email, 'key' => $result->download_id ), trailingslashit( home_url() ) ),
						'download_id' => $result->download_id,
						'product_id' => $result->product_id,
						'download_name' => $download_name,
						'order_id' => $order->id,
						'order_key' => $order->order_key,
						'downloads_remaining' => $result->downloads_remaining
					);

					$file_number++;

				endif;

			endforeach;

		endif;

		return apply_filters('woocommerce_customer_get_downloadable_products', $downloads);
	}
}