e, $customer ) { $this->set_array_meta( $key, $value, $customer ); } /** * Sets a field value in an array meta, supporting routing things to billing, shipping, or additional fields, based on a prefix for the key. * * @param string $key The field key. * @param mixed $value The field value. * @param \WC_Customer|\WC_Order $object The object to set the field value for. * * @return void */ private function set_array_meta( $key, $value, $object ) { $meta_key = ''; if ( 0 === strpos( $key, '/billing/' ) ) { $meta_key = self::BILLING_FIELDS_KEY; $key = str_replace( '/billing/', '', $key ); } elseif ( 0 === strpos( $key, '/shipping/' ) ) { $meta_key = self::SHIPPING_FIELDS_KEY; $key = str_replace( '/shipping/', '', $key ); } else { $meta_key = self::ADDITIONAL_FIELDS_KEY; } if ( $object instanceof \WC_Customer ) { if ( ! $object->get_id() ) { $meta_data = wc()->session->get( $meta_key, array() ); } else { $meta_data = get_user_meta( $object->get_id(), $meta_key, true ); } } elseif ( $object instanceof \WC_Order ) { $meta_data = $object->get_meta( $meta_key, true ); } if ( ! is_array( $meta_data ) ) { $meta_data = array(); } $meta_data[ $key ] = $value; if ( $object instanceof \WC_Customer ) { if ( ! $object->get_id() ) { wc()->session->set( $meta_key, $meta_data ); } else { update_user_meta( $object->get_id(), $meta_key, $meta_data ); } } elseif ( $object instanceof \WC_Order ) { $object->update_meta_data( $meta_key, $meta_data ); } } /** * Returns a field value for a given object. * * @param string $key The field key. * @param \WC_Customer $customer The customer to get the field value for. * @param string $group The group to get the field value for (shipping|billing|'') in which '' refers to the additional group. * * @return mixed The field value. */ public function get_field_from_customer( $key, $customer, $group = '' ) { return $this->get_field_from_object( $key, $customer, $group ); } /** * Returns a field value for a given order. * * @param string $field The field key. * @param \WC_Order $order The order to get the field value for. * @param string $group The group to get the field value for (shipping|billing|'') in which '' refers to the additional group. * * @return mixed The field value. */ public function get_field_from_order( $field, $order, $group = '' ) { return $this->get_field_from_object( $field, $order, $group ); } /** * Returns a field value for a given object. * * @param string $key The field key. * @param \WC_Customer|\WC_Order $object The customer to get the field value for. * @param string $group The group to get the field value for (shipping|billing|'') in which '' refers to the additional group. * * @return mixed The field value. */ private function get_field_from_object( $key, $object, $group = '' ) { $meta_key = ''; if ( 0 === strpos( $key, '/billing/' ) || 'billing' === $group ) { $meta_key = self::BILLING_FIELDS_KEY; $key = str_replace( '/billing/', '', $key ); } elseif ( 0 === strpos( $key, '/shipping/' ) || 'shipping' === $group ) { $meta_key = self::SHIPPING_FIELDS_KEY; $key = str_replace( '/shipping/', '', $key ); } else { $meta_key = self::ADDITIONAL_FIELDS_KEY; } if ( $object instanceof \WC_Customer ) { if ( ! $object->get_id() ) { $meta_data = wc()->session->get( $meta_key, array() ); } else { $meta_data = get_user_meta( $object->get_id(), $meta_key, true ); } } elseif ( $object instanceof \WC_Order ) { $meta_data = $object->get_meta( $meta_key, true ); } if ( ! is_array( $meta_data ) ) { return ''; } if ( ! isset( $meta_data[ $key ] ) ) { return ''; } return $meta_data[ $key ]; } /** * Returns an array of all fields values for a given customer. * * @param \WC_Customer $customer The customer to get the fields for. * @param bool $all Whether to return all fields or only the ones that are still registered. Default false. * * @return array An array of fields. */ public function get_all_fields_from_customer( $customer, $all = false ) { $customer_id = $customer->get_id(); $meta_data = array( 'billing' => array(), 'shipping' => array(), 'additional' => array(), ); if ( ! $customer_id ) { if ( isset( wc()->session ) ) { $meta_data['billing'] = wc()->session->get( self::BILLING_FIELDS_KEY, array() ); $meta_data['shipping'] = wc()->session->get( self::SHIPPING_FIELDS_KEY, array() ); $meta_data['additional'] = wc()->session->get( self::ADDITIONAL_FIELDS_KEY, array() ); } } else { $meta_data['billing'] = get_user_meta( $customer_id, self::BILLING_FIELDS_KEY, true ); $meta_data['shipping'] = get_user_meta( $customer_id, self::SHIPPING_FIELDS_KEY, true ); $meta_data['additional'] = get_user_meta( $customer_id, self::ADDITIONAL_FIELDS_KEY, true ); } return $this->format_meta_data( $meta_data, $all ); } /** * Returns an array of all fields values for a given order. * * @param \WC_Order $order The order to get the fields for. * @param bool $all Whether to return all fields or only the ones that are still registered. Default false. * * @return array An array of fields. */ public function get_all_fields_from_order( $order, $all = false ) { $meta_data = array( 'billing' => array(), 'shipping' => array(), 'additional' => array(), ); if ( $order instanceof \WC_Order ) { $meta_data['billing'] = $order->get_meta( self::BILLING_FIELDS_KEY, true ); $meta_data['shipping'] = $order->get_meta( self::SHIPPING_FIELDS_KEY, true ); $meta_data['additional'] = $order->get_meta( self::ADDITIONAL_FIELDS_KEY, true ); } return $this->format_meta_data( $meta_data, $all ); } /** * Returns an array of all fields values for a given meta object. It would add the billing or shipping prefix to the keys. * * @param array $meta The meta data to format. * @param bool $all Whether to return all fields or only the ones that are still registered. Default false. * * @return array An array of fields. */ private function format_meta_data( $meta, $all = false ) { $billing_fields = $meta['billing'] ?? array(); $shipping_fields = $meta['shipping'] ?? array(); $additional_fields = $meta['additional'] ?? array(); $fields = array(); if ( is_array( $billing_fields ) ) { foreach ( $billing_fields as $key => $value ) { if ( ! $all && ! $this->is_field( $key ) ) { continue; } $fields[ '/billing/' . $key ] = $value; } } if ( is_array( $shipping_fields ) ) { foreach ( $shipping_fields as $key => $value ) { if ( ! $all && ! $this->is_field( $key ) ) { continue; } $fields[ '/shipping/' . $key ] = $value; } } if ( is_array( $additional_fields ) ) { foreach ( $additional_fields as $key => $value ) { if ( ! $all && ! $this->is_field( $key ) ) { continue; } $fields[ $key ] = $value; } } return $fields; } /** * From a set of fields, returns only the ones that should be saved to the customer. * For now, this only supports fields in address location. * * @param array $fields The fields to filter. * * @return array The filtered fields. */ public function filter_fields_for_customer( $fields ) { $customer_fields_keys = $this->get_address_fields_keys(); return array_filter( $fields, function( $key ) use ( $customer_fields_keys ) { return in_array( $key, $customer_fields_keys, true ); }, ARRAY_FILTER_USE_KEY ); } }