*/ class Activecampaign_For_Woocommerce_Ecom_Order implements Ecom_Model, Has_Id, Has_Email { use Activecampaign_For_Woocommerce_Data_Validation, Api_Serializable { serialize_to_array as serialize_all_but_products_to_array; set_properties_from_serialized_array as set_all_but_products_as_properties_from_serialized_array; } /** * The mappings for the Api_Serializable trait. * * @var array */ public $api_mappings = array( 'abandoned_date' => 'abandonedDate', 'connectionid' => 'connectionid', 'customerid' => 'customerid', 'currency' => 'currency', 'email' => 'email', 'externalid' => 'externalid', 'externalcheckoutid' => 'externalcheckoutid', 'external_created_date' => 'externalCreatedDate', 'external_updated_date' => 'externalUpdatedDate', 'id' => 'id', 'order_number' => 'orderNumber', 'source' => 'source', 'total_price' => 'totalPrice', 'total_products' => 'totalProducts', 'order_date' => 'orderDate', 'order_url' => 'orderUrl', 'discount_amount' => 'discountAmount', 'order_discounts' => 'orderDiscounts', 'shipping_amount' => 'shippingAmount', 'shipping_method' => 'shippingMethod', 'tax_amount' => 'taxAmount', ); /** * The mapping for the discount array. * * @var array The discount mapping array. */ private $discount_mappings = array( 'name' => 'name', 'type' => 'type', 'discount_amount' => 'discountAmount', ); /** * The required fields for an ecom order * * @var array */ private $required_fields = array( 'email', 'total_price', 'source', 'connectionid', 'order_number', 'customerid', 'currency', 'external_created_date', ); /** * The abandoned date. * * @var string */ private $abandoned_date; /** * The connection id. * * @var string */ private $connectionid; /** * The customer id. * * @var string */ public $customerid; /** * The currency. * * @var string */ private $currency; /** * The email. * * @var string */ private $email; /** * The external id. * * @var string */ private $externalid; /** * The external checkout id. * * @var string */ private $externalcheckoutid; /** * The external created date. * * @var string */ private $external_created_date; /** * The external updated date. * * @var string */ private $external_updated_date; /** * The id. * * @var string */ private $id; /** * The order number. * * @var string */ private $order_number; /** * An array of Order Products for this order. * * @var Activecampaign_For_Woocommerce_Ecom_Product[] */ private $order_products = array(); /** * The source (1 or 0). * * @var string */ private $source; /** * The total price. * * @var string */ private $total_price; /** * The total products. * * @var string */ private $total_products; /** * The order date. * * @var string */ private $order_date; /** * The order/cart url. * * @var string */ private $order_url; /** * The order discount amount. * * @var string */ private $discount_amount; /** * The order discounts applied. * * @var array */ private $order_discounts; /** * The order shipping amount. * * @var string */ private $shipping_amount; /** * The order shipping method. * * @var string */ private $shipping_method; /** * The order tax amount. * * @var string */ private $tax_amount; /** * Returns the abandoned date. * * @return string */ public function get_abandoned_date() { return $this->abandoned_date; } /** * Sets the abandoned date. * * @param string $abandoned_date The abandoned date. */ public function set_abandoned_date( $abandoned_date ) { $this->abandoned_date = $abandoned_date; } /** * Returns the connection id. * * @return string */ public function get_connectionid() { return $this->connectionid; } /** * Sets the connection id. * * @param string $connectionid The connection id. */ public function set_connectionid( $connectionid ) { $this->connectionid = $connectionid; } /** * Returns the customer id. * * @return string */ public function get_customerid() { return $this->customerid; } /** * Sets the customer id. * * @param string $customerid The customer id. */ public function set_customerid( $customerid ) { $this->customerid = $customerid; } /** * Returns the currency. * * @return string */ public function get_currency() { return $this->currency; } /** * Sets the currency. * * @param string $currency The currency. */ public function set_currency( $currency ) { $this->currency = strtolower( $currency ); } /** * Returns the email. * * @return string */ public function get_email() { return $this->email; } /** * Sets the email. * * @param string $email The email. * @throws RuntimeException Throws an exception for an invalid email to get a catch. */ public function set_email( $email ) { if ( self::check_valid_email( $email ) ) { $this->email = $email; } else { $this->email = null; } } /** * Returns the external id. * * @return string */ public function get_externalid() { return $this->externalid; } /** * Sets the external id. * * @param string $externalid The external id. */ public function set_externalid( $externalid ) { $this->externalid = $externalid; } /** * Returns the external checkout id. * * @return string */ public function get_externalcheckoutid() { return $this->externalcheckoutid; } /** * Sets the external checkout id. * * @param string $externalcheckoutid The external checkout id. */ public function set_externalcheckoutid( $externalcheckoutid ) { $this->externalcheckoutid = $externalcheckoutid; } /** * Returns the external created date. * * @return string */ public function get_external_created_date() { return $this->external_created_date; } /** * Sets the external created date. * * @param string $external_created_date The external created date. */ public function set_external_created_date( $external_created_date ) { $this->external_created_date = $external_created_date; } /** * Returns the external updated date. * * @return string */ public function get_external_updated_date() { return $this->external_updated_date; } /** * Sets the external updated date. * * @param string $external_updated_date The external updated date. */ public function set_external_updated_date( $external_updated_date ) { $this->external_updated_date = $external_updated_date; } /** * Returns the id. * * @return string */ public function get_id() { return $this->id; } /** * Sets the id. * * @param string $id The id. */ public function set_id( $id ) { $this->id = $id; } /** * Returns the order number. * * @return string */ public function get_order_number() { return $this->order_number; } /** * Sets the order number. * * @param string $order_number The order number. */ public function set_order_number( $order_number ) { $this->order_number = $order_number; } /** * Returns the source (sync = 0 or webhook = 1). * * @return string */ public function get_source() { return $this->source; } /** * Sets the source. * 0 = historical * 1 = active (will trigger automations) * * @param string $source The source (1=active or 0=historical). */ public function set_source( $source ) { $this->source = $source; } /** * Returns the total price. * * @return string */ public function get_total_price() { return $this->total_price; } /** * Sets the total price. * * @param string $total_price The total price. */ public function set_total_price( $total_price ) { $this->total_price = (string) $total_price; } /** * Set the order date * * @param string $date_time The order date. */ public function set_order_date( $date_time ) { $this->order_date = $date_time; } /** * Get the order date * * @return string */ public function get_order_date() { return $this->order_date; } /** * Set the order url. * * @param string $url The order url. */ public function set_order_url( $url ) { $this->order_url = $url; } /** * Get the order url. * * @return string */ public function get_order_url() { return $this->order_url; } /** * Set the order discount total. * * @param string $discount The order total discount. */ public function set_discount_amount( $discount ) { $this->discount_amount = $discount; } /** * Get the order total discount. * * @return string */ public function get_discount_amount() { return $this->discount_amount; } /** * Set the order discount array. * * @param array $discounts The order discount array. */ public function set_order_discounts( $discounts ) { $this->order_discounts = $discounts; } /** * Get the order discounts. * * @return array The order discount array. */ public function get_order_discounts() { return $this->order_discounts; } /** * Set the order shipping total. * * @param string $shipping The order total shipping. */ public function set_shipping_amount( $shipping ) { $this->shipping_amount = $shipping; } /** * Get the order total shipping. * * @return string */ public function get_shipping_amount() { return $this->shipping_amount; } /** * Set the order shipping method. * * @param string $shipping The order shipping method. */ public function set_shipping_method( $shipping ) { $this->shipping_method = $shipping; } /** * Get the order shipping method. * * @return string */ public function get_shipping_method() { return $this->shipping_method; } /** * Set the order tax total. * * @param string $tax The order tax total. */ public function set_tax_amount( $tax ) { $this->tax_amount = $tax; } /** * Get the order tax total. * * @return string */ public function get_tax_amount() { return $this->tax_amount; } /** * Returns the total products. * * @return string */ public function get_total_products() { return $this->total_products; } /** * Sets the total products. * * @param string $total_products The total products. */ public function set_total_products( $total_products ) { $this->total_products = (string) $total_products; } /** * Adds an Ecom product to the array of ecom products. * * @param Activecampaign_For_Woocommerce_Ecom_Product $order_product The ecom product to be added. */ public function push_order_product( Activecampaign_For_Woocommerce_Ecom_Product $order_product ) { $this->order_products[] = $order_product; } /** * Returns the array of ecom products. * * @return Activecampaign_For_Woocommerce_Ecom_Product[] */ public function get_order_products() { return $this->order_products; } /** * Sets the properties from a serialized array returned from the API. * * Calls the set properties method of the trait used in this class, but first * massages the data due to how ecom order products are returned by the API. * * @param array $array The serialized array. */ public function set_properties_from_serialized_array( array $array ) { $logger = new Logger(); try { $this->set_all_but_products_as_properties_from_serialized_array( $array ); if ( isset( $array['orderProducts'] ) ) { foreach ( $array['orderProducts'] as $product ) { if ( ! isset( $product['orderid'] ) ) { $product['orderid'] = $this->get_id(); } $order_product = new Activecampaign_For_Woocommerce_Ecom_Product(); if ( isset( $product ) ) { $order_product->set_properties_from_serialized_array( $product ); $this->push_order_product( $order_product ); } } } if ( isset( $array['orderDiscounts'] ) ) { foreach ( $array['orderDiscounts'] as $order_discounts ) { $mappings = $this->discount_mappings; // e.g., "order_number" => "orderNumber" foreach ( $mappings as $local_name => $remote_name ) { if ( isset( $array[ $remote_name ] ) ) { // e.g., set_order_number() $set_method = "set_$local_name"; // e.g. $this->set_order_number($array['orderNumber']); $this->$set_method( $array[ $remote_name ] ); } } } } } catch ( Throwable $t ) { $logger->warning( 'There was an issue setting properties from serialized array on the ecom order', array( 'message' => $t->getMessage(), 'suggested_action' => 'Please refer to the message for explanation.', 'passed_array' => $array, 'trace' => $logger->clean_trace( $t->getTrace() ), 'ac_code' => 'EOM_688', ) ); } } /** * Serializes the model to an associative array. * * Calls the serialize method of the trait used in this class, but first * massages the data due to how ecom order products are expected by the API. * * @return array */ public function serialize_to_array() { try { $array = $this->serialize_all_but_products_to_array(); $order_products = array(); foreach ( $this->order_products as $order_product ) { $order_products[] = $order_product->serialize_to_array(); } $array['orderProducts'] = $order_products; return $array; } catch ( Throwable $t ) { $logger = new Logger(); $logger->warning( 'Activecampaign_For_Woocommerce_Ecom_Order: The serialize_to_array function encountered an issue. A valid order object may not exist.', array( 'message' => $t->getMessage(), 'trace' => $logger->clean_trace( $t->getTrace() ), 'ac_code' => 'EOM_723', ) ); return null; } } /** * Validate the required fields and return a bool * * @return bool */ public function validate_model() { $logger = new Logger(); try { if ( empty( $this->email ) ) { $logger->error( 'Email is missing from this order. It will not be synced.', array( 'email' => $this->email, 'suggested_action' => 'Please verify this order has an email address related to it.', 'ac_code' => 'EOM_746', ) ); return false; } // One of these is required if ( empty( $this->externalcheckoutid ) && empty( $this->externalid ) ) { $logger->warning( 'Activecampaign_For_Woocommerce_Ecom_Order: No external ID has been set. This is required.', array( 'email' => $this->email, 'order_number' => $this->order_number, 'ac_code' => 'EOM_759', ) ); return false; } foreach ( $this->required_fields as $field ) { if ( 'source' === $field && ( '0' !== $this->{$field} && '1' !== $this->{$field} ) ) { $logger->error( 'Source must be a 0 or 1. This record may have the wrong source set.', array( 'suggested_action' => 'There may be an issue with processing the data. Please contact support if this continues to be an issue.', 'failed_field_name' => $field, 'connectionid' => $this->connectionid, 'email' => $this->email, 'total_price' => $this->total_price, 'order_source' => $this->source, 'order_number' => $this->order_number, 'customerid' => $this->customerid, 'ac_code' => 'EOM_774', ) ); return false; } if ( 'total_price' === $field && ! isset( $this->{$field} ) ) { $logger->warning( 'Total price is not valid on this order.', array( 'suggested_action' => 'Please verify the order has a total of zero or more. If the data for total price is null or negative it may not sync to ActiveCampaign.', 'failed_field_name' => $field, 'connectionid' => $this->connectionid, 'email' => $this->email, 'total_price' => $this->total_price, 'order_source' => $this->source, 'order_number' => $this->order_number, 'customerid' => $this->customerid, 'ac_code' => 'EOM_792', ) ); return false; } if ( 'total_price' !== $field && 'source' !== $field && empty( $this->{$field} ) ) { $logger->error( 'A field in this order data may not be valid and this order will not sync to ActiveCampaign.', array( 'suggested_action' => 'Please verify the fields in this log entry and determine if the data is actually missing from your order.', 'failed_field_name' => $field, 'connectionid' => $this->connectionid, 'email' => $this->email, 'total_price' => $this->total_price, 'order_source' => $this->source, 'order_number' => $this->order_number, 'customerid' => $this->customerid, 'ac_code' => 'EOM_810', ) ); return false; } } } catch ( Throwable $t ) { $logger->warning( 'Activecampaign_For_Woocommerce_Ecom_Order: There was an error validating the ecom order model.', array( 'message' => $t->getMessage(), 'trace' => $logger->clean_trace( $t->getTrace() ), 'ac_code' => 'EOM_828', ) ); } return true; } /** * Converts the order to json. * * @return false|string */ public function order_to_json() { return wp_json_encode( $this->serialize_to_array() ); } }