wps_product_ctr

Complexity

Total Complexity

88

Size/Duplication

Total Lines	406
Duplicated Lines	19.7 %

Coupling/Cohesion

Components	0
Dependencies	8

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
B	install_modules()	18	18	7
A	__construct()	0	15	1
A	callback_admin_enqueue_scripts()	0	7	2
A	display_product_caracteristics_tab()	14	14	4
A	display_discount_chip()	14	14	4
F	check_stock()	12	45	19
C	get_inconsistent_product()	0	80	18
A	get_thumbnail()	0	11	3
A	update_attributes_for_product()	0	9	4
B	update_the_attribute_for_product()	0	28	2
A	wpshop_product_title()	11	11	3
A	wpshop_product_content()	11	11	3
C	wpshop_product_thumbnail()	0	38	11
B	wpshop_product_sheet_output()	0	21	7

<?php if ( !defined( 'ABSPATH' ) ) exit;
class wps_product_ctr {

	/**
	 * Ce constructeur appelle l'action admin_enqueue_scripts de Wordpress et ajout des
	 * 5 shortcodes.
	 *
	 * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

	 */
	function __construct() {

It is generally recommended to explicitly declare the visibility for methods.

		add_action( 'admin_enqueue_scripts', array( &$this, 'callback_admin_enqueue_scripts' ) );

		add_shortcode( 'wps_product_caracteristics', array( $this, 'display_product_caracteristics_tab' ) );
		add_shortcode( 'wpshop_product_caracteristics', array( $this, 'display_product_caracteristics_tab' ) );
		add_shortcode( 'wps_product_discount_chip', array( $this, 'display_discount_chip' ) );
		add_shortcode( 'wpshop_product_discount_chip', array( $this, 'display_discount_chip' ) );

		add_shortcode( 'wpshop_product_title', array( $this, 'wpshop_product_title' ) );
		add_shortcode( 'wpshop_product_content', array( $this, 'wpshop_product_content' ) );
		add_shortcode( 'wpshop_product_thumbnail', array( $this, 'wpshop_product_thumbnail' ) );

		/** Product sheet Page **/
		add_action( 'admin_post_wps_product_sheet', array( $this, 'wpshop_product_sheet_output' ) );
	}

	/**
	 * CORE - Install all extra-modules in "Modules" folder
	 */
	function install_modules() {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		/**	Define the directory containing all exrta-modules for current plugin	*/
		$module_folder = WPS_PRODUCT_PATH . '/modules/';

		/**	Check if the defined directory exists for reading and including the different modules	*/
		if( is_dir( $module_folder ) ) {
			$parent_folder_content = scandir( $module_folder );
			foreach ( $parent_folder_content as $folder ) {
				if ( $folder && substr( $folder, 0, 1) != '.' && is_dir( $module_folder . $folder ) ) {
					$child_folder_content = scandir( $module_folder . $folder );
					if ( file_exists( $module_folder . $folder . '/' . $folder . '.php') ) {
						$f =  $module_folder . $folder . '/' . $folder . '.php';
						include( $f );
					}
				}
			}
		}
	}

	public function callback_admin_enqueue_scripts( $hook ) {
		wp_enqueue_script( 'wps_backend_product_js', WPS_PRODUCT_URL . '/asset/js/backend-product.js', array( "jquery", "jquery-form" ), WPS_PRODUCT_VERSION );
		if( $hook != 'tools_page_wpshop_tools' )
			return;

		wp_enqueue_script( 'wps_product_js', WPS_PRODUCT_URL . '/asset/js/backend.js', array( "jquery", "jquery-form" ), WPS_PRODUCT_VERSION );
	}

	/**
	 * Display Product's caracteristics tab in complete product sheet
	 * @param array $args
	 * @return string
	 */
	function display_product_caracteristics_tab( $args ) {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		$output = '';
		if( !empty($args) && !empty($args['pid']) ) {
			$wps_product_mdl = new wps_product_mdl();
			$product_atts_def = $wps_product_mdl->get_product_atts_def( $args['pid'] );
			if( !empty($product_atts_def) ) {
				ob_start();
				require( wpshop_tools::get_template_part( WPS_PRODUCT_DIR, WPS_PRODUCT_TEMPLATES_MAIN_DIR, "frontend", "product_caracteristics_tab") );
				$output = ob_get_contents();
				ob_end_clean();
			}
		}
		return $output;
	}

	/**
	 * Display Discount Chip
	 * @param array $args
	 * @return string
	 */
	function display_discount_chip( $args ) {

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

		$output = '';
		if( !empty($args) && !empty($args['pid']) ) {
			$wps_price = new wpshop_prices();
			$discount_data = wpshop_prices::check_discount_for_product( $args['pid'] );
			if( !empty($discount_data) ) {
				ob_start();
				require( wpshop_tools::get_template_part( WPS_PRODUCT_DIR, WPS_PRODUCT_TEMPLATES_MAIN_DIR, "frontend", "product_discount_chip") );
				$output = ob_get_contents();
				ob_end_clean();
			}
		}
		return $output;
	}

	/**
	 * Check if there is enough stock for asked product if manage stock option is checked
	 *
	 * @param integer $product_id The product we have to check the stock for
	 * @param unknown_type $cart_asked_quantity The quantity the end user want to add to the cart
	 *
	 * @return boolean|string  If there is enough sotck or if the option for managing stock is set to false return OK (true) In the other case return an alert message for the user
	 */
	function check_stock($product_id, $cart_asked_quantity, $combined_variation_id = '') {

It is generally recommended to explicitly declare the visibility for methods.

		// Checking if combined variation ID exist and it is a simple option
		if( !empty($combined_variation_id) && ( strpos($combined_variation_id, '__') !== false ) ) {

This code seems to be duplicated across your project.

			$var_id = explode( '__', $combined_variation_id);
			$combined_variation_id = $var_id[1];
		}


		if ( !empty($combined_variation_id) ) {

			$variation_metadata = get_post_meta( $combined_variation_id, '_wpshop_product_metadata', true );
			if ( isset($variation_metadata['product_stock']) ) {
				$product_id = $combined_variation_id;
			} else {
				$product_id = wp_get_post_parent_id( $combined_variation_id );
				$product_id = ( $product_id ) ? $product_id : $combined_variation_id;
			}
		}
		$product_data = wpshop_products::get_product_data($product_id, false, '"publish", "free_product"');

		if(!empty($product_data)) {
			$manage_stock = !empty($product_data['manage_stock']) ? $product_data['manage_stock'] : '';

			$product_post_type = get_post_type( $product_id );

			if ( $product_post_type == WPSHOP_NEWTYPE_IDENTIFIER_PRODUCT_VARIATION ) {

This code seems to be duplicated across your project.

				$parent_def = wpshop_products::get_parent_variation( $product_id );
				if ( !empty($parent_def) && !empty($parent_def['parent_post']) ) {
					$parent_post = $parent_def['parent_post'];
					$parent_product_data = wpshop_products::get_product_data($parent_post->ID);
					$manage_stock = empty( $manage_stock ) ? $parent_product_data['manage_stock'] : $manage_stock;
				}
			}
			$manage_stock_is_activated = (!empty($manage_stock) && ( strtolower(__($manage_stock, 'wpshop')) == strtolower(__('Yes', 'wpshop')) )) ? true : false;
			$the_qty_is_in_stock = ( !empty($product_data['product_stock']) && $product_data['product_stock'] >= $cart_asked_quantity ) ? true : false ;

			if (($manage_stock_is_activated && $the_qty_is_in_stock) OR !$manage_stock_is_activated) {
				return true;
			}
			else {
				return __('You cannot add that amount to the cart since there is not enough stock.', 'wpshop');
			}
		}
		return false;
	}

	public static function get_inconsistent_product() {
		$price_piloting_option = get_option( 'wpshop_shop_price_piloting' );

		$entity_id 		= wpshop_entities::get_entity_identifier_from_code( 'wpshop_product' );

		$attribute_def	= wpshop_attributes::getElement( ( $price_piloting_option == 'TTC' ) ? 'product_price' : 'price_ht', "'valid'", 'code' );
		$attribute_id	= $attribute_def->id;

		global $wpdb;

		$wpdb->query('SET SESSION group_concat_max_len = 10000');

		$query			= "
		SELECT 		post.ID, post.post_title, attr_val_dec.value as price_attribute, GROUP_CONCAT(postmeta.meta_key, '&sep&', postmeta.meta_value, '&&' ORDER BY postmeta.meta_key) as price
			FROM 		$wpdb->posts as post
		JOIN		$wpdb->postmeta as postmeta
			ON			post.ID=postmeta.post_id
		JOIN		" . WPSHOP_DBT_ATTRIBUTE_VALUES_DECIMAL . " attr_val_dec
			ON			post.ID=attr_val_dec.entity_id
		WHERE		post.post_type='wpshop_product'
			AND			attr_val_dec.entity_type_id=%d
			AND			attr_val_dec.attribute_id=%d
			AND			postmeta.meta_key IN( '_product_price', '_wps_price_infos', '_wpshop_displayed_price', '_wpshop_product_metadata' )
		GROUP BY	post.ID";

		$list_product	= $wpdb->get_results( $wpdb->prepare( $query, array( $entity_id, $attribute_id ) ) );

		if( !empty( $list_product ) ) {
			foreach( $list_product as $key_product => &$product ) {
				$product->price = explode('&&,', $product->price);
				if(!empty($product->price) && is_array($product->price)) {
					$array_price = array();
					foreach($product->price as &$price) {
						if(strpos( $price, '&&' ))
							$price = substr($price, 0, -2);

						$tmp_price = explode('&sep&', $price);
						$key = $tmp_price[0];
						$price = maybe_unserialize($tmp_price[1]);

						/** _wpshop_product_metadata */
						if( $key == '_wpshop_product_metadata' ) {
							$array_price[$key] =  ( $price_piloting_option == 'TTC' ) ? $price['product_price'] : $price['price_ht'];
						}

						/** _wps_price_infos */
						if( $key == '_wps_price_infos' ) {
							$array_price[$key] = !empty( $price['PRODUCT_PRICE'] ) ? $price['PRODUCT_PRICE'] : '-';
						}

						if( $key == '_product_price' ) {
							$array_price[$key] = ( $price_piloting_option == 'TTC' ) ? $price : '-';
						}

						if ( $key == '_wpshop_displayed_price' ) {
							$array_price[$key] = $price;
						}
						unset($price);
					}

					$array_meta_list = array( '_product_price', '_wps_price_infos', '_wpshop_displayed_price', '_wpshop_product_metadata', );

					foreach( $array_meta_list as $meta_list ) {
						if( !array_key_exists( $meta_list, $array_price ) ) {
							$array_price[$meta_list] = 0;
						}
					}

					$product->price = $array_price;
					if( $product->price_attribute === $product->price['_wpshop_product_metadata'] ) {
						unset($list_product[$key_product]);
					}

				}
			}
			unset($product);
		}

		return $list_product;
	}

	/**
	 * Récupères l'image vedette d'un produit selon son $id
	 *
	 * @param int $pid L'id du produit
	 * @return WP_Post
	 */
	public function get_thumbnail ( $pid ) {
		if( empty( $pid ) )
			return null;

		$thumbnail_id = get_post_meta( $pid, '_thumbnail_id', true );

		if( empty( $thumbnail_id ) )
			return null;

		return $thumbnail_id;
	}

	/**
	 * Read the array_data table and call update_the_attribute_for_product for update the attribute value for this product
	 *
	 * @param int $product_id The product ID
	 * @param array $array_data The array data [integer][barcode] = 0111100001
	 */
	public function update_attributes_for_product($product_id, $array_data) {
		if(!empty($array_data)) {
			foreach($array_data as $type => $array) {
				foreach($array as $name_attribute => $value_attribute) {
					$this->update_the_attribute_for_product($product_id, $type, $name_attribute, $value_attribute);
				}
			}
		}
	}

	/**
	 * Insert ou met à jour la value dans la table correspondante selon le product_id et le nom de l'attribut
	 *
	 * @param int $product_id L'id du produit
	 * @param string $type Peut être varchar, integer, text, options, decimal, datetime
	 * @param string $attribute_name Le code d'un attribut

There is no parameter named $attribute_name. Was it maybe removed?

	 * @param string $attribute_value La valeur à mêttre à jour

There is no parameter named $attribute_value. Was it maybe removed?

	 */
	public function update_the_attribute_for_product($product_id, $type, $name_attribute, $value_attribute) {
		global $wpdb;

		/** On récupère l'id de l'entity produit */
 		$entity_type_id = wpshop_entities::get_entity_identifier_from_code(WPSHOP_NEWTYPE_IDENTIFIER_PRODUCT);

		$attribute_id = $wpdb->get_var($wpdb->prepare('SELECT id FROM ' . WPSHOP_DBT_ATTRIBUTE . ' WHERE code="%s"', array($name_attribute)));

		/** On vérifie s'il existe si c'est le cas, on update sinon on insert */
		if(count($wpdb->get_row($wpdb->prepare('SELECT value_id FROM ' . WPSHOP_DBT_ATTRIBUTE . '_value_' . $type . ' WHERE entity_id=%d AND attribute_id IN(SELECT id FROM ' . WPSHOP_DBT_ATTRIBUTE . ' WHERE code="%s")', array($product_id, $name_attribute)))) > 0) {
			$wpdb->query(
				$wpdb->prepare('UPDATE ' . WPSHOP_DBT_ATTRIBUTE . '_value_' . $type . ' SET value="%s" WHERE entity_id=%d AND attribute_id=%d',
					array($value_attribute, $product_id, $attribute_id)
				)
			);
		}
		else {
			/** Insert avec toutes les informations requise */
			$wpdb->insert(WPSHOP_DBT_ATTRIBUTE . '_value_' . $type, array(
					'attribute_id' 			=> $attribute_id,
					'entity_id'	 			=> $product_id,
					'entity_type_id' 		=> $entity_type_id,
					'creation_date_value' 	=> current_time('mysql'),
					'value' 				=> $value_attribute,
				)
			);
		}
	}

	/**
	 * Shortcode qui permet d'avoir le titre du produit selon son $id
	 *
	 * @param array $args [ 'id' ] L'id du produit
	 * @return string
	 */
	public function wpshop_product_title( $args ) {

This method seems to be duplicated in your project.

		$output = __( 'No product has been found.', 'wpshop' );

		if ( !empty( $args ) && !empty( $args['pid'] ) ) {
			global $wpdb;
			$query = "SELECT post_title FROM {$wpdb->posts} WHERE ID = %d";
			$output = $wpdb->get_var( $wpdb->prepare( $query, $args['pid'] ) );
		}

		return $output;
	}

	/**
	 * Shortcode qui permet d'avoir la description d'un produit selon son $id
	 * @param array $args [ 'id' ] L'id du produit
	 * @return string
	 */
	public function wpshop_product_content( $args ) {

This method seems to be duplicated in your project.

		$output = __( 'No product has been found.', 'wpshop' );

		if ( !empty( $args ) && !empty( $args['pid'] ) ) {
			global $wpdb;
			$query = "SELECT post_content FROM {$wpdb->posts} WHERE ID = %d";
			$output = $wpdb->get_var( $wpdb->prepare( $query, $args['pid'] ) );
		}

		return nl2br( $output );
	}

	/**
	 * Shortcode qui permet d'afficher l'image vedette d'un produit selon son $id
	 *
	 * @param array $args 	[ pid ] L'id du produit
	 * 						[ size ] La taille de l'image. Peut être défini comme : small, medium ou full
	 * @return string
	 */
	public function wpshop_product_thumbnail( $args ) {
		$url_thumbnail = WPSHOP_DEFAULT_PRODUCT_PICTURE;
		$size = '20%';

		if ( !empty( $args ) && !empty( $args['size'] ) ) {
			switch ( $args['size'] ) {
				case 'small':
					$size = '20%';
					break;
				case 'medium':
					$size = '50%';
					break;
				case 'full':
					$size = '100%';
					break;
				default:
					break;
			}
		}

		if ( !empty( $args ) && !empty( $args['pid'] ) ) {
			$thumbnail_id = $this->get_thumbnail( $args['pid'] );

			if( !empty( $thumbnail_id ) ) {
				$attachment = get_post( $thumbnail_id );

				if( !empty( $attachment ) && !empty( $attachment->guid ) ) {
					$url_thumbnail = $attachment->guid;
				}
			}
		}

		ob_start();
		require( wpshop_tools::get_template_part( WPS_PRODUCT_DIR, WPS_PRODUCT_TEMPLATES_MAIN_DIR, "frontend", "product_thumbnail" ) );
		$output = ob_get_clean();

		return $output;
	}

	/**
	 *	Output product sheet to PDF
	 */
	public function wpshop_product_sheet_output() {
		$product_id = ( !empty($_GET['pid']) ) ? (int) $_GET['pid'] : null;
		$user_id = get_current_user_id();
		if( !empty($product_id) && get_post_type( $product_id ) == WPSHOP_NEWTYPE_IDENTIFIER_PRODUCT && $user_id != 0 && current_user_can( 'manage_options' ) ) {
			$wps_product_administration_ctr = new wps_product_administration_ctr();
			$html_content = $wps_product_administration_ctr->generate_product_sheet_datas( $product_id );
			$product_post = get_post( $product_id );
			require_once(WPSHOP_LIBRAIRIES_DIR.'HTML2PDF/html2pdf.class.php');
			try {
				$html2pdf = new HTML2PDF('P', 'A4', 'fr');
				$html2pdf->pdf->SetDisplayMode('fullpage');
				$html2pdf->setDefaultFont('Arial');
				$html2pdf->writeHTML($html_content);
				$html2pdf->Output('product-' .$product_id.'-'.$product_post->post_name.'.pdf', 'D');
			}
			catch (HTML2PDF_exception $e) {
				echo $e;
			}
		}
		die();
	}
}