add-attribute-terms.php
9 months ago
add-customer.php
10 months ago
add-emails-to-coupon.php
9 months ago
add-order-note.php
11 months ago
add-product-attributes.php
9 months ago
add-product-to-cart.php
9 months ago
add-update-order-custom-fields.php
11 months ago
apply-coupon.php
9 months ago
check-cart-status.php
9 months ago
check-if-order-is-renewal.php
5 months ago
create-attribute.php
9 months ago
create-bundle-product-order.php
7 months ago
create-coupon-code.php
11 months ago
create-multi-product-order.php
8 months ago
create-new-order.php
11 months ago
create-product-variation.php
1 year ago
create-product.php
1 year ago
create-variable-product.php
9 months ago
delete-coupon.php
1 year ago
delete-customer.php
9 months ago
fetch-coupon-details.php
11 months ago
find-orders-by-user-id.php
11 months ago
get-all-customers.php
9 months ago
get-all-products.php
9 months ago
get-customer-by-email.php
9 months ago
get-customer-by-id.php
9 months ago
get-order-details-by-order-id.php
11 months ago
get-order-type-by-order-id.php
5 months ago
get-orders-by-email.php
9 months ago
get-product-by-id.php
1 year ago
list-all-order-notes.php
9 months ago
list-all-orders.php
9 months ago
remove-product-from-cart.php
9 months ago
retrieve-coupons-totals.php
11 months ago
retrieve-customers-totals.php
11 months ago
retrieve-orders-totals.php
11 months ago
retrieve-products-totals.php
11 months ago
retrieve-refunds-list.php
11 months ago
retrieve-reviews-totals.php
11 months ago
retrieve-sales-report.php
11 months ago
retrieve-top-sellers-report.php
11 months ago
update-product-price.php
9 months ago
update-product-stock-quantity.php
9 months ago
update-status-of-order.php
11 months ago
get-customer-by-email.php
273 lines
| 1 | <?php |
| 2 | /** |
| 3 | * GetCustomerByEmail. |
| 4 | * php version 5.6 |
| 5 | * |
| 6 | * @category GetCustomerByEmail |
| 7 | * @package SureTriggers |
| 8 | * @author BSF <username@example.com> |
| 9 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3 |
| 10 | * @link https://www.brainstormforce.com/ |
| 11 | * @since 1.0.0 |
| 12 | */ |
| 13 | |
| 14 | namespace SureTriggers\Integrations\Woocommerce\Actions; |
| 15 | |
| 16 | use SureTriggers\Integrations\AutomateAction; |
| 17 | use SureTriggers\Traits\SingletonLoader; |
| 18 | use WC_Customer; |
| 19 | use Exception; |
| 20 | |
| 21 | /** |
| 22 | * GetCustomerByEmail |
| 23 | * |
| 24 | * @category GetCustomerByEmail |
| 25 | * @package SureTriggers |
| 26 | * @author BSF <username@example.com> |
| 27 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3 |
| 28 | * @link https://www.brainstormforce.com/ |
| 29 | * @since 1.0.0 |
| 30 | */ |
| 31 | class GetCustomerByEmail extends AutomateAction { |
| 32 | |
| 33 | /** |
| 34 | * Integration type. |
| 35 | * |
| 36 | * @var string |
| 37 | */ |
| 38 | public $integration = 'WooCommerce'; |
| 39 | |
| 40 | /** |
| 41 | * Action name. |
| 42 | * |
| 43 | * @var string |
| 44 | */ |
| 45 | public $action = 'wc_get_customer_by_email'; |
| 46 | |
| 47 | use SingletonLoader; |
| 48 | |
| 49 | /** |
| 50 | * Register a action. |
| 51 | * |
| 52 | * @param array $actions actions. |
| 53 | * @return array |
| 54 | */ |
| 55 | public function register( $actions ) { |
| 56 | $actions[ $this->integration ][ $this->action ] = [ |
| 57 | 'label' => __( 'Get Customer by Email', 'suretriggers' ), |
| 58 | 'action' => 'wc_get_customer_by_email', |
| 59 | 'function' => [ $this, 'action_listener' ], |
| 60 | ]; |
| 61 | return $actions; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Action listener. |
| 66 | * |
| 67 | * @param int $user_id user_id. |
| 68 | * @param int $automation_id automation_id. |
| 69 | * @param array $fields fields. |
| 70 | * @param array $selected_options selectedOptions. |
| 71 | * |
| 72 | * @return void|array|bool |
| 73 | */ |
| 74 | public function _action_listener( $user_id, $automation_id, $fields, $selected_options ) { |
| 75 | if ( ! function_exists( 'WC' ) || ! class_exists( 'WC_Customer' ) ) { |
| 76 | return [ |
| 77 | 'status' => 'error', |
| 78 | 'message' => __( 'WooCommerce not available', 'suretriggers' ), |
| 79 | ]; |
| 80 | } |
| 81 | |
| 82 | // Validate required fields. |
| 83 | foreach ( $fields as $field ) { |
| 84 | if ( array_key_exists( 'validationProps', $field ) && empty( $selected_options[ $field['name'] ] ) ) { |
| 85 | return [ |
| 86 | 'status' => 'error', |
| 87 | 'message' => __( 'Required field is missing: ', 'suretriggers' ) . $field['name'], |
| 88 | ]; |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | // Get customer email from options. |
| 93 | $customer_email = ! empty( $selected_options['customer_email'] ) ? sanitize_email( $selected_options['customer_email'] ) : ''; |
| 94 | |
| 95 | if ( empty( $customer_email ) || ! is_email( $customer_email ) ) { |
| 96 | return [ |
| 97 | 'status' => 'error', |
| 98 | 'message' => __( 'Valid customer email is required', 'suretriggers' ), |
| 99 | ]; |
| 100 | } |
| 101 | |
| 102 | try { |
| 103 | // Get user by email. |
| 104 | $user = get_user_by( 'email', $customer_email ); |
| 105 | |
| 106 | if ( ! $user ) { |
| 107 | return [ |
| 108 | 'status' => 'error', |
| 109 | 'message' => __( 'Customer not found with this email address', 'suretriggers' ), |
| 110 | ]; |
| 111 | } |
| 112 | |
| 113 | $customer_id = $user->ID; |
| 114 | |
| 115 | // Get the customer. |
| 116 | $customer = new WC_Customer( $customer_id ); |
| 117 | |
| 118 | // Check if customer exists. |
| 119 | if ( ! $customer->get_id() ) { |
| 120 | return [ |
| 121 | 'status' => 'error', |
| 122 | 'message' => __( 'WooCommerce customer profile not found', 'suretriggers' ), |
| 123 | ]; |
| 124 | } |
| 125 | |
| 126 | // Get customer's last order. |
| 127 | $last_order = $customer->get_last_order(); |
| 128 | $last_order_data = []; |
| 129 | if ( $last_order ) { |
| 130 | $last_order_data = [ |
| 131 | 'id' => $last_order->get_id(), |
| 132 | 'status' => $last_order->get_status(), |
| 133 | 'total' => $last_order->get_total(), |
| 134 | 'date_created' => $last_order->get_date_created() ? $last_order->get_date_created()->getTimestamp() : null, |
| 135 | ]; |
| 136 | } |
| 137 | |
| 138 | // Get customer's orders count and total spent. |
| 139 | $orders_count = $customer->get_order_count(); |
| 140 | $total_spent = $customer->get_total_spent(); |
| 141 | |
| 142 | // Get billing address. |
| 143 | $billing_address = [ |
| 144 | 'first_name' => $customer->get_billing_first_name(), |
| 145 | 'last_name' => $customer->get_billing_last_name(), |
| 146 | 'company' => $customer->get_billing_company(), |
| 147 | 'address_1' => $customer->get_billing_address_1(), |
| 148 | 'address_2' => $customer->get_billing_address_2(), |
| 149 | 'city' => $customer->get_billing_city(), |
| 150 | 'state' => $customer->get_billing_state(), |
| 151 | 'postcode' => $customer->get_billing_postcode(), |
| 152 | 'country' => $customer->get_billing_country(), |
| 153 | 'email' => $customer->get_billing_email(), |
| 154 | 'phone' => $customer->get_billing_phone(), |
| 155 | ]; |
| 156 | |
| 157 | // Get shipping address. |
| 158 | $shipping_address = [ |
| 159 | 'first_name' => $customer->get_shipping_first_name(), |
| 160 | 'last_name' => $customer->get_shipping_last_name(), |
| 161 | 'company' => $customer->get_shipping_company(), |
| 162 | 'address_1' => $customer->get_shipping_address_1(), |
| 163 | 'address_2' => $customer->get_shipping_address_2(), |
| 164 | 'city' => $customer->get_shipping_city(), |
| 165 | 'state' => $customer->get_shipping_state(), |
| 166 | 'postcode' => $customer->get_shipping_postcode(), |
| 167 | 'country' => $customer->get_shipping_country(), |
| 168 | ]; |
| 169 | |
| 170 | // Get country and state names. |
| 171 | $billing_country_name = ''; |
| 172 | $billing_state_name = ''; |
| 173 | $shipping_country_name = ''; |
| 174 | $shipping_state_name = ''; |
| 175 | |
| 176 | if ( function_exists( 'WC' ) && WC()->countries ) { |
| 177 | $countries = WC()->countries->get_countries(); |
| 178 | |
| 179 | // Get billing country and state names. |
| 180 | if ( ! empty( $billing_address['country'] ) && isset( $countries[ $billing_address['country'] ] ) ) { |
| 181 | $billing_country_name = $countries[ $billing_address['country'] ]; |
| 182 | $states = WC()->countries->get_states( $billing_address['country'] ); |
| 183 | if ( ! empty( $billing_address['state'] ) && isset( $states[ $billing_address['state'] ] ) ) { |
| 184 | $billing_state_name = $states[ $billing_address['state'] ]; |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | // Get shipping country and state names. |
| 189 | if ( ! empty( $shipping_address['country'] ) && isset( $countries[ $shipping_address['country'] ] ) ) { |
| 190 | $shipping_country_name = $countries[ $shipping_address['country'] ]; |
| 191 | $states = WC()->countries->get_states( $shipping_address['country'] ); |
| 192 | if ( ! empty( $shipping_address['state'] ) && isset( $states[ $shipping_address['state'] ] ) ) { |
| 193 | $shipping_state_name = $states[ $shipping_address['state'] ]; |
| 194 | } |
| 195 | } |
| 196 | } |
| 197 | |
| 198 | // Get user meta data. |
| 199 | $user_meta = get_user_meta( $customer_id ); |
| 200 | $additional_data = []; |
| 201 | if ( is_array( $user_meta ) ) { |
| 202 | foreach ( $user_meta as $key => $value ) { |
| 203 | if ( is_string( $key ) && ! str_starts_with( $key, '_' ) ) { // Skip private meta keys. |
| 204 | $additional_data[ $key ] = is_array( $value ) && count( $value ) === 1 ? $value[0] : $value; |
| 205 | } |
| 206 | } |
| 207 | } |
| 208 | |
| 209 | // Get recent orders (last 5). |
| 210 | $recent_orders = []; |
| 211 | $orders = wc_get_orders( |
| 212 | [ |
| 213 | 'customer' => $customer_email, |
| 214 | 'limit' => 5, |
| 215 | 'orderby' => 'date', |
| 216 | 'order' => 'DESC', |
| 217 | ] |
| 218 | ); |
| 219 | |
| 220 | if ( is_array( $orders ) ) { |
| 221 | foreach ( $orders as $order ) { |
| 222 | if ( $order instanceof \WC_Order ) { |
| 223 | $recent_orders[] = [ |
| 224 | 'id' => $order->get_id(), |
| 225 | 'status' => $order->get_status(), |
| 226 | 'total' => $order->get_total(), |
| 227 | 'date_created' => $order->get_date_created() ? $order->get_date_created()->getTimestamp() : null, |
| 228 | 'payment_method' => $order->get_payment_method_title(), |
| 229 | 'items_count' => $order->get_item_count(), |
| 230 | ]; |
| 231 | } |
| 232 | } |
| 233 | } |
| 234 | |
| 235 | return [ |
| 236 | 'status' => 'success', |
| 237 | 'message' => __( 'Customer retrieved successfully', 'suretriggers' ), |
| 238 | 'customer_id' => $customer->get_id(), |
| 239 | 'username' => $customer->get_username(), |
| 240 | 'email' => $customer->get_email(), |
| 241 | 'search_email' => $customer_email, |
| 242 | 'first_name' => $customer->get_first_name(), |
| 243 | 'last_name' => $customer->get_last_name(), |
| 244 | 'display_name' => $customer->get_display_name(), |
| 245 | 'date_created' => $customer->get_date_created() ? $customer->get_date_created()->getTimestamp() : null, |
| 246 | 'date_modified' => $customer->get_date_modified() ? $customer->get_date_modified()->getTimestamp() : null, |
| 247 | 'role' => ! empty( $user->roles ) ? $user->roles[0] : '', |
| 248 | 'avatar_url' => $customer->get_avatar_url(), |
| 249 | 'orders_count' => $orders_count, |
| 250 | 'total_spent' => wc_format_decimal( $total_spent, 2 ), |
| 251 | 'last_order' => $last_order_data, |
| 252 | 'recent_orders' => $recent_orders, |
| 253 | 'billing_address' => $billing_address, |
| 254 | 'shipping_address' => $shipping_address, |
| 255 | 'billing_country_name' => $billing_country_name, |
| 256 | 'billing_state_name' => $billing_state_name, |
| 257 | 'shipping_country_name' => $shipping_country_name, |
| 258 | 'shipping_state_name' => $shipping_state_name, |
| 259 | 'is_paying_customer' => $customer->get_is_paying_customer(), |
| 260 | 'additional_data' => $additional_data, |
| 261 | ]; |
| 262 | |
| 263 | } catch ( Exception $e ) { |
| 264 | return [ |
| 265 | 'status' => 'error', |
| 266 | 'message' => __( 'Error retrieving customer: ', 'suretriggers' ) . $e->getMessage(), |
| 267 | ]; |
| 268 | } |
| 269 | } |
| 270 | } |
| 271 | |
| 272 | GetCustomerByEmail::get_instance(); |
| 273 |