woocommerce/includes/class-wc-product-factory.php

120 lines
3.6 KiB
PHP

<?php
/**
* Product Factory
*
* The WooCommerce product factory creating the right product object.
*
* @package WooCommerce/Classes
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Product factory class.
*/
class WC_Product_Factory {
/**
* Get a product.
*
* @param mixed $product_id WC_Product|WP_Post|int|bool $product Product instance, post instance, numeric or false to use global $post.
* @param array $deprecated Previously used to pass arguments to the factory, e.g. to force a type.
* @return WC_Product|bool Product object or false if the product cannot be loaded.
*/
public function get_product( $product_id = false, $deprecated = array() ) {
$product_id = $this->get_product_id( $product_id );
if ( ! $product_id ) {
return false;
}
$product_type = $this->get_product_type( $product_id );
// Backwards compatibility.
if ( ! empty( $deprecated ) ) {
wc_deprecated_argument( 'args', '3.0', 'Passing args to the product factory is deprecated. If you need to force a type, construct the product class directly.' );
if ( isset( $deprecated['product_type'] ) ) {
$product_type = $this->get_classname_from_product_type( $deprecated['product_type'] );
}
}
$classname = $this->get_product_classname( $product_id, $product_type );
try {
return new $classname( $product_id, $deprecated );
} catch ( Exception $e ) {
return false;
}
}
/**
* Gets a product classname and allows filtering. Returns WC_Product_Simple if the class does not exist.
*
* @since 3.0.0
* @param int $product_id Product ID.
* @param string $product_type Product type.
* @return string
*/
public static function get_product_classname( $product_id, $product_type ) {
$classname = apply_filters( 'woocommerce_product_class', self::get_classname_from_product_type( $product_type ), $product_type, 'variation' === $product_type ? 'product_variation' : 'product', $product_id );
if ( ! $classname || ! class_exists( $classname ) ) {
$classname = 'WC_Product_Simple';
}
return $classname;
}
/**
* Get the product type for a product.
*
* @since 3.0.0
* @param int $product_id Product ID.
* @return string|false
*/
public static function get_product_type( $product_id ) {
// Allow the overriding of the lookup in this function. Return the product type here.
$override = apply_filters( 'woocommerce_product_type_query', false, $product_id );
if ( ! $override ) {
return WC_Data_Store::load( 'product' )->get_product_type( $product_id );
} else {
return $override;
}
}
/**
* Create a WC coding standards compliant class name e.g. WC_Product_Type_Class instead of WC_Product_type-class.
*
* @param string $product_type Product type.
* @return string|false
*/
public static function get_classname_from_product_type( $product_type ) {
return $product_type ? 'WC_Product_' . implode( '_', array_map( 'ucfirst', explode( '-', $product_type ) ) ) : false;
}
/**
* Get the product ID depending on what was passed.
*
* @since 3.0.0
* @param WC_Product|WP_Post|int|bool $product Product instance, post instance, numeric or false to use global $post.
* @return int|bool false on failure
*/
private function get_product_id( $product ) {
global $post;
if ( false === $product && isset( $post, $post->ID ) && 'product' === get_post_type( $post->ID ) ) {
return absint( $post->ID );
} elseif ( is_numeric( $product ) ) {
return $product;
} elseif ( $product instanceof WC_Product ) {
return $product->get_id();
} elseif ( ! empty( $product->ID ) ) {
return $product->ID;
} else {
return false;
}
}
}