woocommerce/includes/data-stores/class-wc-customer-data-stor...

200 lines
5.2 KiB
PHP
Raw Normal View History

2016-11-14 18:18:08 +00:00
<?php
/**
* Class WC_Customer_Data_Store_Session file.
*
* @package WooCommerce\DataStores
*/
2016-11-14 18:18:08 +00:00
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* WC Customer Data Store which stores the data in session.
*
2017-03-15 16:36:53 +00:00
* @version 3.0.0
2016-11-14 18:18:08 +00:00
*/
2016-11-22 13:54:51 +00:00
class WC_Customer_Data_Store_Session extends WC_Data_Store_WP implements WC_Customer_Data_Store_Interface, WC_Object_Data_Store_Interface {
2016-11-14 18:18:08 +00:00
/**
* Keys which are also stored in a session (so we can make sure they get updated...)
2018-03-07 19:16:01 +00:00
*
2016-11-14 18:18:08 +00:00
* @var array
*/
protected $session_keys = array(
'id',
'date_modified',
2016-11-14 18:18:08 +00:00
'billing_postcode',
'billing_city',
'billing_address_1',
'billing_address',
'billing_address_2',
'billing_state',
'billing_country',
'shipping_postcode',
'shipping_city',
'shipping_address_1',
'shipping_address',
'shipping_address_2',
'shipping_state',
'shipping_country',
'is_vat_exempt',
'calculated_shipping',
'billing_first_name',
'billing_last_name',
'billing_company',
'billing_phone',
'billing_email',
'shipping_first_name',
'shipping_last_name',
'shipping_company',
2021-06-03 12:55:37 +00:00
'shipping_phone',
2016-11-14 18:18:08 +00:00
);
/**
* Simply update the session.
*
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
*/
public function create( &$customer ) {
$this->save_to_session( $customer );
}
/**
* Simply update the session.
*
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
*/
public function update( &$customer ) {
$this->save_to_session( $customer );
}
/**
* Saves all customer data to the session.
*
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
*/
public function save_to_session( $customer ) {
$data = array();
foreach ( $this->session_keys as $session_key ) {
$function_key = $session_key;
if ( 'billing_' === substr( $session_key, 0, 8 ) ) {
$session_key = str_replace( 'billing_', '', $session_key );
}
$data[ $session_key ] = (string) $customer->{"get_$function_key"}( 'edit' );
2016-11-14 18:18:08 +00:00
}
2017-12-21 19:00:55 +00:00
WC()->session->set( 'customer', $data );
2016-11-14 18:18:08 +00:00
}
/**
* Read customer data from the session unless the user has logged in, in
* which case the stored ID will differ from the actual ID.
2016-11-14 18:18:08 +00:00
*
2017-03-15 16:36:53 +00:00
* @since 3.0.0
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
*/
public function read( &$customer ) {
$data = (array) WC()->session->get( 'customer' );
/**
* There is a valid session if $data is not empty, and the ID matches the logged in user ID.
*
* If the user object has been updated since the session was created (based on date_modified) we should not load the session - data should be reloaded.
*/
2017-12-21 19:00:55 +00:00
if ( isset( $data['id'], $data['date_modified'] ) && $data['id'] === (string) $customer->get_id() && $data['date_modified'] === (string) $customer->get_date_modified( 'edit' ) ) {
2016-11-14 18:18:08 +00:00
foreach ( $this->session_keys as $session_key ) {
2017-12-21 19:00:55 +00:00
if ( in_array( $session_key, array( 'id', 'date_modified' ), true ) ) {
continue;
}
2016-11-14 18:18:08 +00:00
$function_key = $session_key;
if ( 'billing_' === substr( $session_key, 0, 8 ) ) {
$session_key = str_replace( 'billing_', '', $session_key );
}
2019-01-15 16:49:01 +00:00
if ( isset( $data[ $session_key ] ) && is_callable( array( $customer, "set_{$function_key}" ) ) ) {
2017-11-06 15:48:11 +00:00
$customer->{"set_{$function_key}"}( wp_unslash( $data[ $session_key ] ) );
2016-11-14 18:18:08 +00:00
}
}
}
$this->set_defaults( $customer );
$customer->set_object_read( true );
}
/**
* Load default values if props are unset.
*
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
*/
protected function set_defaults( &$customer ) {
try {
$default = wc_get_customer_default_location();
$has_shipping_address = $customer->has_shipping_address();
2016-11-14 18:18:08 +00:00
if ( ! $customer->get_billing_country() ) {
$customer->set_billing_country( $default['country'] );
}
2016-11-14 18:18:08 +00:00
if ( ! $customer->get_shipping_country() && ! $has_shipping_address ) {
$customer->set_shipping_country( $customer->get_billing_country() );
}
2016-11-14 18:18:08 +00:00
if ( ! $customer->get_billing_state() ) {
$customer->set_billing_state( $default['state'] );
}
2016-11-14 18:18:08 +00:00
if ( ! $customer->get_shipping_state() && ! $has_shipping_address ) {
$customer->set_shipping_state( $customer->get_billing_state() );
}
if ( ! $customer->get_billing_email() && is_user_logged_in() ) {
$current_user = wp_get_current_user();
$customer->set_billing_email( $current_user->user_email );
}
} catch ( WC_Data_Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
2018-03-07 19:16:01 +00:00
}
2016-11-14 18:18:08 +00:00
}
/**
* Deletes a customer from the database.
*
2017-03-15 16:36:53 +00:00
* @since 3.0.0
* @param WC_Customer $customer Customer object.
2018-03-07 19:16:01 +00:00
* @param array $args Array of args to pass to the delete method.
2016-11-14 18:18:08 +00:00
*/
2016-11-15 18:11:25 +00:00
public function delete( &$customer, $args = array() ) {
2016-11-14 18:18:08 +00:00
WC()->session->set( 'customer', null );
}
/**
* Gets the customers last order.
*
2017-03-15 16:36:53 +00:00
* @since 3.0.0
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
* @return WC_Order|false
*/
public function get_last_order( &$customer ) {
return false;
}
/**
* Return the number of orders this customer has.
*
2017-03-15 16:36:53 +00:00
* @since 3.0.0
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
* @return integer
*/
public function get_order_count( &$customer ) {
return 0;
}
/**
* Return how much money this customer has spent.
*
2017-03-15 16:36:53 +00:00
* @since 3.0.0
* @param WC_Customer $customer Customer object.
2016-11-14 18:18:08 +00:00
* @return float
*/
public function get_total_spent( &$customer ) {
return 0;
}
}