woocommerce/includes/class-wc-customer.php

1109 lines
26 KiB
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 3.0.0
* @package WooCommerce/Classes
* @category Class
* @author WooThemes
*/
class WC_Customer extends WC_Legacy_Customer {
/**
* Stores customer data.
*
* @var array
*/
protected $data = array(
'date_created' => null,
'date_modified' => null,
'email' => '',
'first_name' => '',
'last_name' => '',
'display_name' => '',
'role' => 'customer',
'username' => '',
'billing' => array(
'first_name' => '',
'last_name' => '',
'company' => '',
'address_1' => '',
'address_2' => '',
'city' => '',
'state' => '',
'postcode' => '',
'country' => '',
'email' => '',
'phone' => '',
),
'shipping' => array(
'first_name' => '',
'last_name' => '',
'company' => '',
'address_1' => '',
'address_2' => '',
'city' => '',
'state' => '',
'postcode' => '',
'country' => '',
),
'is_paying_customer' => false,
);
/**
* Stores a password if this needs to be changed. Write-only and hidden from _data.
*
* @var string
*/
protected $password = '';
/**
* Stores if user is VAT exempt for this session.
*
* @var string
*/
protected $is_vat_exempt = false;
/**
* Stores if user has calculated shipping in this session.
*
* @var string
*/
protected $calculated_shipping = false;
/**
* Load customer data based on how WC_Customer is called.
*
* If $customer is 'new', 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.
*
* @param WC_Customer|int $data Customer ID or data.
* @param bool $is_session True if this is the customer session
* @throws Exception if customer cannot be read/found and $data is set.
*/
public function __construct( $data = 0, $is_session = false ) {
parent::__construct( $data );
if ( $data instanceof WC_Customer ) {
$this->set_id( absint( $data->get_id() ) );
} elseif ( is_numeric( $data ) ) {
$this->set_id( $data );
}
$this->data_store = WC_Data_Store::load( 'customer' );
// If we have an ID, load the user from the DB.
if ( $this->get_id() ) {
try {
$this->data_store->read( $this );
} catch ( Exception $e ) {
$this->set_id( 0 );
$this->set_object_read( true );
}
} else {
$this->set_object_read( true );
}
// If this is a session, set or change the data store to sessions. Changes do not persist in the database.
if ( $is_session ) {
$this->data_store = WC_Data_Store::load( 'customer-session' );
$this->data_store->read( $this );
}
}
/**
* Prefix for action and filter hooks on data.
*
* @since 3.0.0
* @return string
*/
protected function get_hook_prefix() {
return 'woocommerce_customer_get_';
}
/**
* Delete a customer and reassign posts..
*
* @param int $reassign Reassign posts and links to new User ID.
* @since 3.0.0
* @return bool
*/
public function delete_and_reassign( $reassign = null ) {
if ( $this->data_store ) {
$this->data_store->delete( $this, array( 'force_delete' => true, 'reassign' => $reassign ) );
$this->set_id( 0 );
return true;
}
return false;
}
/**
* 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;
}
/**
* Return this customer's avatar.
*
* @since 3.0.0
* @return string
*/
public function get_avatar_url() {
return get_avatar_url( $this->get_email() );
}
/**
* 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 === apply_filters( 'woocommerce_apply_base_tax_for_local_pickup', true ) && sizeof( array_intersect( wc_get_chosen_shipping_method_ids(), 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_billing_country();
$state = $this->get_billing_state();
$postcode = $this->get_billing_postcode();
$city = $this->get_billing_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->get_id() ) {
$downloads = wc_get_customer_available_downloads( $this->get_id() );
}
return apply_filters( 'woocommerce_customer_get_downloadable_products', $downloads );
}
/**
* Is customer VAT exempt?
*
* @return bool
*/
public function is_vat_exempt() {
return $this->get_is_vat_exempt();
}
/**
* Has calculated shipping?
*
* @return bool
*/
public function has_calculated_shipping() {
return $this->get_calculated_shipping();
}
/**
* Get if customer is VAT exempt?
*
* @since 3.0.0
* @return bool
*/
public function get_is_vat_exempt() {
return $this->is_vat_exempt;
}
/**
* Get password (only used when updating the user object).
*
* @return string
*/
public function get_password() {
return $this->password;
}
/**
* Has customer calculated shipping?
*
* @return bool
*/
public function get_calculated_shipping() {
return $this->calculated_shipping;
}
/**
* Set if customer has tax exemption.
*
* @param bool $is_vat_exempt
*/
public function set_is_vat_exempt( $is_vat_exempt ) {
$this->is_vat_exempt = wc_string_to_bool( $is_vat_exempt );
}
/**
* Calculated shipping?
*
* @param boolean $calculated
*/
public function set_calculated_shipping( $calculated = true ) {
$this->calculated_shipping = wc_string_to_bool( $calculated );
}
/**
* Set customer's password.
*
* @since 3.0.0
* @param string $password
* @throws WC_Data_Exception
*/
public function set_password( $password ) {
$this->password = wc_clean( $password );
}
/**
* Gets the customers last order.
*
* @param WC_Customer
* @return WC_Order|false
*/
public function get_last_order() {
return $this->data_store->get_last_order( $this );
}
/**
* Return the number of orders this customer has.
*
* @param WC_Customer
* @return integer
*/
public function get_order_count() {
return $this->data_store->get_order_count( $this );
}
/**
* Return how much money this customer has spent.
*
* @param WC_Customer
* @return float
*/
public function get_total_spent() {
return $this->data_store->get_total_spent( $this );
}
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
*/
/**
* Return the customer's username.
*
* @since 3.0.0
* @param string $context
* @return string
*/
public function get_username( $context = 'view' ) {
return $this->get_prop( 'username', $context );
}
/**
* Return the customer's email.
*
* @since 3.0.0
* @param string $context
* @return string
*/
public function get_email( $context = 'view' ) {
return $this->get_prop( 'email', $context );
}
/**
* Return customer's first name.
*
* @since 3.0.0
* @param string $context
* @return string
*/
public function get_first_name( $context = 'view' ) {
return $this->get_prop( 'first_name', $context );
}
/**
* Return customer's last name.
*
* @since 3.0.0
* @param string $context
* @return string
*/
public function get_last_name( $context = 'view' ) {
return $this->get_prop( 'last_name', $context );
}
/**
* Return customer's display name.
*
* @since 3.1.0
* @param string $context
* @return string
*/
public function get_display_name( $context = 'view' ) {
return $this->get_prop( 'display_name', $context );
}
/**
* Return customer's user role.
*
* @since 3.0.0
* @param string $context
* @return string
*/
public function get_role( $context = 'view' ) {
return $this->get_prop( 'role', $context );
}
/**
* Return the date this customer was created.
*
* @since 3.0.0
* @param string $context
* @return WC_DateTime|null object if the date is set or null if there is no date.
*/
public function get_date_created( $context = 'view' ) {
return $this->get_prop( 'date_created', $context );
}
/**
* Return the date this customer was last updated.
*
* @since 3.0.0
* @param string $context
* @return WC_DateTime|null object if the date is set or null if there is no date.
*/
public function get_date_modified( $context = 'view' ) {
return $this->get_prop( 'date_modified', $context );
}
/**
* Gets a prop for a getter method.
*
* @since 3.0.0
* @param string $prop Name of prop to get.
* @param string $address billing or shipping.
* @param string $context What the value is for. Valid values are view and edit.
* @return mixed
*/
protected function get_address_prop( $prop, $address = 'billing', $context = 'view' ) {
$value = null;
if ( array_key_exists( $prop, $this->data[ $address ] ) ) {
$value = isset( $this->changes[ $address ][ $prop ] ) ? $this->changes[ $address ][ $prop ] : $this->data[ $address ][ $prop ];
if ( 'view' === $context ) {
$value = apply_filters( $this->get_hook_prefix() . $address . '_' . $prop, $value, $this );
}
}
return $value;
}
/**
* Get billing.
*
* @since 3.2.0
* @param string $context
* @return array
*/
public function get_billing( $context = 'view' ) {
return $this->get_prop( 'billing', $context );
}
/**
* Get billing_first_name.
*
* @param string $context
* @return string
*/
public function get_billing_first_name( $context = 'view' ) {
return $this->get_address_prop( 'first_name', 'billing', $context );
}
/**
* Get billing_last_name.
*
* @param string $context
* @return string
*/
public function get_billing_last_name( $context = 'view' ) {
return $this->get_address_prop( 'last_name', 'billing', $context );
}
/**
* Get billing_company.
*
* @param string $context
* @return string
*/
public function get_billing_company( $context = 'view' ) {
return $this->get_address_prop( 'company', 'billing', $context );
}
/**
* Get billing_address_1.
*
* @param string $context
* @return string
*/
public function get_billing_address( $context = 'view' ) {
return $this->get_billing_address_1( $context );
}
/**
* Get billing_address_1.
*
* @param string $context
* @return string
*/
public function get_billing_address_1( $context = 'view' ) {
return $this->get_address_prop( 'address_1', 'billing', $context );
}
/**
* Get billing_address_2.
*
* @param string $context
* @return string $value
*/
public function get_billing_address_2( $context = 'view' ) {
return $this->get_address_prop( 'address_2', 'billing', $context );
}
/**
* Get billing_city.
*
* @param string $context
* @return string $value
*/
public function get_billing_city( $context = 'view' ) {
return $this->get_address_prop( 'city', 'billing', $context );
}
/**
* Get billing_state.
*
* @param string $context
* @return string
*/
public function get_billing_state( $context = 'view' ) {
return $this->get_address_prop( 'state', 'billing', $context );
}
/**
* Get billing_postcode.
*
* @param string $context
* @return string
*/
public function get_billing_postcode( $context = 'view' ) {
return $this->get_address_prop( 'postcode', 'billing', $context );
}
/**
* Get billing_country.
*
* @param string $context
* @return string
*/
public function get_billing_country( $context = 'view' ) {
return $this->get_address_prop( 'country', 'billing', $context );
}
/**
* Get billing_email.
*
* @param string $context
* @return string
*/
public function get_billing_email( $context = 'view' ) {
return $this->get_address_prop( 'email', 'billing', $context );
}
/**
* Get billing_phone.
*
* @param string $context
* @return string
*/
public function get_billing_phone( $context = 'view' ) {
return $this->get_address_prop( 'phone', 'billing', $context );
}
/**
* Get shipping.
*
* @since 3.2.0
* @param string $context
* @return array
*/
public function get_shipping( $context = 'view' ) {
return $this->get_prop( 'shipping', $context );
}
/**
* Get shipping_first_name.
*
* @param string $context
* @return string
*/
public function get_shipping_first_name( $context = 'view' ) {
return $this->get_address_prop( 'first_name', 'shipping', $context );
}
/**
* Get shipping_last_name.
*
* @param string $context
* @return string
*/
public function get_shipping_last_name( $context = 'view' ) {
return $this->get_address_prop( 'last_name', 'shipping', $context );
}
/**
* Get shipping_company.
*
* @param string $context
* @return string
*/
public function get_shipping_company( $context = 'view' ) {
return $this->get_address_prop( 'company', 'shipping', $context );
}
/**
* Get shipping_address_1.
*
* @param string $context
* @return string
*/
public function get_shipping_address( $context = 'view' ) {
return $this->get_shipping_address_1( $context );
}
/**
* Get shipping_address_1.
*
* @param string $context
* @return string
*/
public function get_shipping_address_1( $context = 'view' ) {
return $this->get_address_prop( 'address_1', 'shipping', $context );
}
/**
* Get shipping_address_2.
*
* @param string $context
* @return string
*/
public function get_shipping_address_2( $context = 'view' ) {
return $this->get_address_prop( 'address_2', 'shipping', $context );
}
/**
* Get shipping_city.
*
* @param string $context
* @return string
*/
public function get_shipping_city( $context = 'view' ) {
return $this->get_address_prop( 'city', 'shipping', $context );
}
/**
* Get shipping_state.
*
* @param string $context
* @return string
*/
public function get_shipping_state( $context = 'view' ) {
return $this->get_address_prop( 'state', 'shipping', $context );
}
/**
* Get shipping_postcode.
*
* @param string $context
* @return string
*/
public function get_shipping_postcode( $context = 'view' ) {
return $this->get_address_prop( 'postcode', 'shipping', $context );
}
/**
* Get shipping_country.
*
* @param string $context
* @return string
*/
public function get_shipping_country( $context = 'view' ) {
return $this->get_address_prop( 'country', 'shipping', $context );
}
/**
* Is the user a paying customer?
*
* @since 3.0.0
* @param string $context
* @return bool
*/
function get_is_paying_customer( $context = 'view' ) {
return $this->get_prop( 'is_paying_customer', $context );
}
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
*/
/**
* Set customer's username.
*
* @since 3.0.0
* @param string $username
* @throws WC_Data_Exception
*/
public function set_username( $username ) {
$this->set_prop( 'username', $username );
}
/**
* Set customer's email.
*
* @since 3.0.0
* @param string $value
* @throws WC_Data_Exception
*/
public function set_email( $value ) {
if ( $value && ! is_email( $value ) ) {
$this->error( 'customer_invalid_email', __( 'Invalid email address', 'woocommerce' ) );
}
$this->set_prop( 'email', sanitize_email( $value ) );
}
/**
* Set customer's first name.
*
* @since 3.0.0
* @param string $first_name
* @throws WC_Data_Exception
*/
public function set_first_name( $first_name ) {
$this->set_prop( 'first_name', $first_name );
}
/**
* Set customer's last name.
*
* @since 3.0.0
* @param string $last_name
* @throws WC_Data_Exception
*/
public function set_last_name( $last_name ) {
$this->set_prop( 'last_name', $last_name );
}
/**
* Set customer's display name.
*
* @since 3.1.0
* @param string $display_name
* @throws WC_Data_Exception
*/
public function set_display_name( $display_name ) {
$this->set_prop( 'display_name', $display_name );
}
/**
* Set customer's user role(s).
*
* @since 3.0.0
* @param mixed $role
* @throws WC_Data_Exception
*/
public function set_role( $role ) {
global $wp_roles;
if ( $role && ! empty( $wp_roles->roles ) && ! in_array( $role, array_keys( $wp_roles->roles ) ) ) {
$this->error( 'customer_invalid_role', __( 'Invalid role', 'woocommerce' ) );
}
$this->set_prop( 'role', $role );
}
/**
* Set the date this customer was last updated.
*
* @since 3.0.0
* @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
* @throws WC_Data_Exception
*/
public function set_date_created( $date = null ) {
$this->set_date_prop( 'date_created', $date );
}
/**
* Set the date this customer was last updated.
*
* @since 3.0.0
* @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
* @throws WC_Data_Exception
*/
public function set_date_modified( $date = null ) {
$this->set_date_prop( 'date_modified', $date );
}
/**
* Set customer address to match shop base address.
*
* @since 3.0.0
* @throws WC_Data_Exception
*/
public function set_billing_address_to_base() {
$base = wc_get_customer_default_location();
$this->set_billing_location( $base['country'], $base['state'], '', '' );
}
/**
* Set customer shipping address to base address.
*
* @since 3.0.0
* @throws WC_Data_Exception
*/
public function set_shipping_address_to_base() {
$base = wc_get_customer_default_location();
$this->set_shipping_location( $base['country'], $base['state'], '', '' );
}
/**
* Sets all address info at once.
*
* @param string $country
* @param string $state
* @param string $postcode
* @param string $city
* @throws WC_Data_Exception
*/
public function set_billing_location( $country, $state = '', $postcode = '', $city = '' ) {
$billing = $this->get_prop( 'billing', 'edit' );
$billing['country'] = $country;
$billing['state'] = $state;
$billing['postcode'] = $postcode;
$billing['city'] = $city;
$this->set_prop( 'billing', $billing );
}
/**
* Sets all shipping info at once.
*
* @param string $country
* @param string $state
* @param string $postcode
* @param string $city
* @throws WC_Data_Exception
*/
public function set_shipping_location( $country, $state = '', $postcode = '', $city = '' ) {
$shipping = $this->get_prop( 'shipping', 'edit' );
$shipping['country'] = $country;
$shipping['state'] = $state;
$shipping['postcode'] = $postcode;
$shipping['city'] = $city;
$this->set_prop( 'shipping', $shipping );
}
/**
* Sets a prop for a setter method.
*
* @since 3.0.0
* @param string $prop Name of prop to set.
* @param string $address Name of address to set. billing or shipping.
* @param mixed $value Value of the prop.
*/
protected function set_address_prop( $prop, $address = 'billing', $value ) {
if ( array_key_exists( $prop, $this->data[ $address ] ) ) {
if ( true === $this->object_read ) {
if ( $value !== $this->data[ $address ][ $prop ] || ( isset( $this->changes[ $address ] ) && array_key_exists( $prop, $this->changes[ $address ] ) ) ) {
$this->changes[ $address ][ $prop ] = $value;
}
} else {
$this->data[ $address ][ $prop ] = $value;
}
}
}
/**
* Set billing_first_name.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_first_name( $value ) {
$this->set_address_prop( 'first_name', 'billing', $value );
}
/**
* Set billing_last_name.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_last_name( $value ) {
$this->set_address_prop( 'last_name', 'billing', $value );
}
/**
* Set billing_company.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_company( $value ) {
$this->set_address_prop( 'company', 'billing', $value );
}
/**
* Set billing_address_1.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_address( $value ) {
$this->set_billing_address_1( $value );
}
/**
* Set billing_address_1.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_address_1( $value ) {
$this->set_address_prop( 'address_1', 'billing', $value );
}
/**
* Set billing_address_2.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_address_2( $value ) {
$this->set_address_prop( 'address_2', 'billing', $value );
}
/**
* Set billing_city.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_city( $value ) {
$this->set_address_prop( 'city', 'billing', $value );
}
/**
* Set billing_state.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_state( $value ) {
$this->set_address_prop( 'state', 'billing', $value );
}
/**
* Set billing_postcode.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_postcode( $value ) {
$this->set_address_prop( 'postcode', 'billing', $value );
}
/**
* Set billing_country.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_country( $value ) {
$this->set_address_prop( 'country', 'billing', $value );
}
/**
* Set billing_email.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_email( $value ) {
if ( $value && ! is_email( $value ) ) {
$this->error( 'customer_invalid_billing_email', __( 'Invalid billing email address', 'woocommerce' ) );
}
$this->set_address_prop( 'email', 'billing', sanitize_email( $value ) );
}
/**
* Set billing_phone.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_billing_phone( $value ) {
$this->set_address_prop( 'phone', 'billing', $value );
}
/**
* Set shipping_first_name.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_first_name( $value ) {
$this->set_address_prop( 'first_name', 'shipping', $value );
}
/**
* Set shipping_last_name.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_last_name( $value ) {
$this->set_address_prop( 'last_name', 'shipping', $value );
}
/**
* Set shipping_company.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_company( $value ) {
$this->set_address_prop( 'company', 'shipping', $value );
}
/**
* Set shipping_address_1.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_address( $value ) {
$this->set_shipping_address_1( $value );
}
/**
* Set shipping_address_1.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_address_1( $value ) {
$this->set_address_prop( 'address_1', 'shipping', $value );
}
/**
* Set shipping_address_2.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_address_2( $value ) {
$this->set_address_prop( 'address_2', 'shipping', $value );
}
/**
* Set shipping_city.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_city( $value ) {
$this->set_address_prop( 'city', 'shipping', $value );
}
/**
* Set shipping_state.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_state( $value ) {
$this->set_address_prop( 'state', 'shipping', $value );
}
/**
* Set shipping_postcode.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_postcode( $value ) {
$this->set_address_prop( 'postcode', 'shipping', $value );
}
/**
* Set shipping_country.
*
* @param string $value
* @throws WC_Data_Exception
*/
public function set_shipping_country( $value ) {
$this->set_address_prop( 'country', 'shipping', $value );
}
/**
* Set if the user a paying customer.
*
* @since 3.0.0
* @param bool $is_paying_customer
* @throws WC_Data_Exception
*/
function set_is_paying_customer( $is_paying_customer ) {
$this->set_prop( 'is_paying_customer', (bool) $is_paying_customer );
}
}