Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed includes/class-wc-product-factory.php PHPCS violations

This commit is contained in:
Claudio Sanches 2018-03-22 15:36:07 -03:00
parent 6eada732b8
commit 73a56469ef
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
includes/class-wc-product-factory.php
View File

@ -1,31 +1,31 @@
<?php <?php
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
/** /**
* Product Factory Class * Product Factory
* *
* The WooCommerce product factory creating the right product object. * The WooCommerce product factory creating the right product object.
* *
* @class WC_Product_Factory * @package WooCommerce/Classes
* @version 3.0.0 * @version 3.0.0
* @package WooCommerce/Classes */
* @category Class
* @author WooThemes defined( 'ABSPATH' ) || exit;
/**
* Product factory class.
*/ */
class WC_Product_Factory { class WC_Product_Factory {
/** /**
* Get a product. * Get a product.
* *
* @param mixed $product_id (default: false) * @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. * @param array $deprecated Previously used to pass arguments to the factory, e.g. to force a type.
* @return WC_Product|bool Product object or null if the product cannot be loaded. * @return WC_Product|bool Product object or null if the product cannot be loaded.
*/ */
public function get_product( $product_id = false, $deprecated = array() ) { public function get_product( $product_id = false, $deprecated = array() ) {
if ( ! $product_id = $this->get_product_id( $product_id ) ) { $product_id = $this->get_product_id( $product_id );
if ( ! $product_id ) {
return false; return false;
} }
@ -53,8 +53,8 @@ class WC_Product_Factory {
* Gets a product classname and allows filtering. Returns WC_Product_Simple if the class does not exist. * Gets a product classname and allows filtering. Returns WC_Product_Simple if the class does not exist.
* *
* @since 3.0.0 * @since 3.0.0
* @param int $product_id * @param int $product_id Product ID.
* @param string $product_type * @param string $product_type Product type.
* @return string * @return string
*/ */
public static function get_product_classname( $product_id, $product_type ) { public static function get_product_classname( $product_id, $product_type ) {
@ -71,7 +71,7 @@ class WC_Product_Factory {
* Get the product type for a product. * Get the product type for a product.
* *
* @since 3.0.0 * @since 3.0.0
* @param int $product_id * @param int $product_id Product ID.
* @return string|false * @return string|false
*/ */
public static function get_product_type( $product_id ) { public static function get_product_type( $product_id ) {
@ -87,7 +87,7 @@ class WC_Product_Factory {
/** /**
* Create a WC coding standards compliant class name e.g. WC_Product_Type_Class instead of WC_Product_type-class. * Create a WC coding standards compliant class name e.g. WC_Product_Type_Class instead of WC_Product_type-class.
* *
* @param string $product_type * @param string $product_type Product type.
* @return string|false * @return string|false
*/ */
public static function get_classname_from_product_type( $product_type ) { public static function get_classname_from_product_type( $product_type ) {
@ -97,8 +97,8 @@ class WC_Product_Factory {
/** /**
* Get the product ID depending on what was passed. * Get the product ID depending on what was passed.
* *
* @since 3.0.0 * @since 3.0.0
* @param mixed $product * @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 * @return int|bool false on failure
*/ */
private function get_product_id( $product ) { private function get_product_id( $product ) {