Skip to content

Handle fetch product data from data stores that don't extend WC_Product_Data_Store_Custom_Table #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pcfreak30 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Handle fetch product data from data stores that don't extend WC_Product_Data_Store_Custom_Table #177

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dcfbf7a
Merge pull request #1 from woocommerce/master
pcfreak30 Feb 22, 2020
f6ea48c
*Handle fetching all product data for a product at one time when the …
pcfreak30 Mar 3, 2020
89fbbc1
*Fix formatting
pcfreak30 Mar 3, 2020
73a18f0
*Check that post id is actually a product before doing any product ty…
pcfreak30 Mar 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
204 changes: 204 additions & 0 deletions includes/class-wc-product-tables-backwards-compatibility.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ public static function unhook() {
public static function get_metadata_from_tables( $result, $post_id, $meta_key, $single ) {
$mapping = self::get_mapping();

if ( empty( $meta_key ) && 'product' === get_post_type( $post_id ) && WC_Product_Factory::get_product_type( $post_id ) && ! self::uses_custom_product_store( $post_id ) ) {
return self::get_record_from_product_table( $post_id );
}

if ( ! isset( $mapping[ $meta_key ] ) ) {
return $result;
}
Expand Down Expand Up @@ -215,6 +219,61 @@ public static function get_from_product_table( $args ) {
return $data[ $args['column'] ];
}

/**
* Fetch all product data for a product
*
* @param int $product_id Product ID.
*
* @return array
*/
public static function get_record_from_product_table( $product_id ) {
global $wpdb;

if ( ! $product_id ) {
return array();
}

// Look in cache for table.
$cached_data = (array) wp_cache_get( 'woocommerce_product_' . $product_id, 'product' );

if ( false !== $cached_data && ! array_diff_key( $cached_data, self::get_core_product_data_map() ) ) {
$cached_data = self::fill_product_data( $product_id, $cached_data );
$cached_data = self::translate_product_data( $cached_data, true );
self::unhook();
$cached_data = array_merge( get_post_meta( $product_id ), $cached_data );
self::hook();

return $cached_data;
}

// Look in cache for bw compat table.
$data = wp_cache_get( 'woocommerce_product_backwards_compatibility_' . $product_id, 'product' );

if ( false === $data ) {
$data = array();
}

if ( array_diff_key( $cached_data, self::get_core_product_data_map() ) ) {
$data = $wpdb->get_row(
$wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}wc_products WHERE product_id = %d", // phpcs:ignore
$product_id
),
ARRAY_A
);
unset( $data['product_id'] );
wp_cache_set( 'woocommerce_product_backwards_compatibility_' . $product_id, $data, 'product' );
}

$data = self::fill_product_data( $product_id, $data );
$data = self::translate_product_data( $data, true );
self::unhook();
$data = array_merge( get_post_meta( $product_id ), $data );
self::hook();

return $data;
}

/**
* Update from product table.
*
Expand Down Expand Up @@ -1643,6 +1702,151 @@ protected static function get_product( $product_id ) {

return $product;
}

/**
* Determine if product uses a store extending WC_Product_Data_Store_Custom_Table
*
* @param int $post_id Product ID.
*
* @return bool
*/
private static function uses_custom_product_store( $post_id ) {

$product_type = WC_Product_Factory::get_product_type( $post_id );
$classname = WC_Product_Factory::get_product_classname( $post_id, $product_type );

/* @var \WC_Product $product */
$product = new $classname( 0 );

return $product->get_data_store() instanceof WC_Product_Data_Store_Custom_Table;
}

/**
* Get a map of core product data between column and internal ids to expected post meta names.
*
* @param bool $all Return only the product data stored in the products table or all core data.
*
* @return array|string[]
*/
private static function get_core_product_data_map( $all = false ) {
$default = array(
'sku' => '_sku',
'image_id' => '_thumbnail_id',
'height' => '_height',
'width' => '_width',
'length' => '_length',
'weight' => '_weight',
'stock_quantity' => '_stock',
'virtual' => '_virtual',
'downloadable' => '_downloadable',
'tax_class' => '_tax_class',
'tax_status' => '_tax_status',
'total_sales' => 'total_sales',
'regular_price' => '_regular_price',
'sale_price' => '_sale_price',
'date_on_sale_from' => '_sale_price_dates_from',
'date_on_sale_to' => '_sale_price_dates_to',
'average_rating' => '_wc_average_rating',
'stock_status' => '_stock_status',
);
if ( $all ) {
return array_merge(
$default,
array(
'manage_stock' => '_manage_stock',
'backorders' => '_backorders',
'low_stock_amount' => '_low_stock_amount',
'sold_individually' => '_sold_individually',
'upsell_ids' => '_upsell_ids',
'cross_sell_ids' => '_crosssell_ids',
'purchase_note' => '_purchase_note',
'default_attributes' => '_default_attributes',
'gallery_image_ids' => '_product_image_gallery',
'download_limit' => '_download_limit',
'download_expiry' => '_download_expiry',
'rating_counts' => '_wc_rating_count',
'review_count' => '_wc_review_count',
)
);
}

return $default;
}

/**
* Add in missing product data
*
* @param int $product_id Product ID.
* @param array $data Product data to merge with.
*
* @return array
*/
private static function fill_product_data( $product_id, array $data ) {
$call_map = self::get_mapping();

$meta_keys = array(
'_backorders',
'_sold_individually',
'_purchase_note',
'_wc_rating_count',
'_wc_review_count',
'_download_limit',
'_download_expiry',
);

$data_keys = array(
'_upsell_ids',
'_crosssell_ids',
'_product_image_gallery',
'_children',
);
$new_data = array();
foreach ( $meta_keys as $key ) {
$new_data[ $key ] = get_post_meta( $product_id, $key, true );
}

foreach ( $data_keys as $key ) {
$mapped_func = $call_map[ $key ]['get']['function'];
$args = $call_map[ $key ]['get']['args'];
$type = $args['type'];
$args['product_id'] = $product_id;

$new_data[ $type ] = call_user_func( $mapped_func, $args );
$new_data[ $type ] = end( $new_data[ $type ] );
}

$new_data = array_merge( $data, self::translate_product_data( $data ) );

return $new_data;
}

/**
* Translate between internal names and meta key identifiers.
*
* @param array $data The product data to change.
* @param bool $column_to_meta If we are convert for return with a get_post_meta call.
*
* @return array
*/
private static function translate_product_data( array $data, $column_to_meta = false ) {
$new_data = array();
$core_map = self::get_core_product_data_map( true );

if ( ! $column_to_meta ) {
$core_map = array_flip( $core_map );
}

foreach ( $data as $key => $item ) {
if ( isset( $core_map[ $key ] ) ) {
$new_data[ $core_map[ $key ] ] = $item;
if ( $column_to_meta ) {
$new_data[ $core_map[ $key ] ] = array( $new_data[ $core_map[ $key ] ] );
}
}
}

return $new_data;
}
}

WC_Product_Tables_Backwards_Compatibility::hook();