cookie_name .= '_' . get_current_blog_id();
add_action( 'init', array( $this, 'populate_products_list' ), 10 );
// populate default fields for the comparison table
$this->default_fields = YITH_Woocompare_Helper::standard_fields();
// page or popup?
$this->page_or_popup = get_option( 'yith_woocompare_use_page_popup', 'popup' );
// add image size
YITH_Woocompare_Helper::set_image_size();
// Add link or button in the products list or
if ( get_option('yith_woocompare_compare_button_in_product_page') == 'yes' ) add_action( 'woocommerce_single_product_summary', array( $this, 'add_compare_link' ), 35 );
if ( get_option('yith_woocompare_compare_button_in_products_list') == 'yes' ) add_action( 'woocommerce_after_shop_loop_item', array( $this, 'add_compare_link' ), 20 );
add_action( 'init', array( $this, 'add_product_to_compare_action' ), 15 );
add_action( 'init', array( $this, 'remove_product_from_compare_action' ), 15 );
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
add_action( 'template_redirect', array( $this, 'compare_table_html' ) );
// add the shortcode
add_shortcode( 'yith_compare_button', array( $this, 'compare_button_sc' ) );
// AJAX
if( version_compare( WC()->version, '2.4', '>=' ) ){
add_action( 'wc_ajax_' . $this->action_add, array( $this, 'add_product_to_compare_ajax' ) );
add_action( 'wc_ajax_' . $this->action_remove, array( $this, 'remove_product_from_compare_ajax' ) );
add_action( 'wc_ajax_' . $this->action_reload, array( $this, 'reload_widget_list_ajax' ) );
}
else {
add_action( 'wp_ajax_' . $this->action_add, array( $this, 'add_product_to_compare_ajax' ) );
add_action( 'wp_ajax_' . $this->action_remove, array( $this, 'remove_product_from_compare_ajax' ) );
add_action( 'wp_ajax_' . $this->action_reload, array( $this, 'reload_widget_list_ajax' ) );
add_action( 'wp_ajax_nopriv_' . $this->action_add, array( $this, 'add_product_to_compare_ajax' ) );
add_action( 'wp_ajax_nopriv_' . $this->action_remove, array( $this, 'remove_product_from_compare_ajax' ) );
add_action( 'wp_ajax_nopriv_' . $this->action_reload, array( $this, 'reload_widget_list_ajax' ) );
}
return $this;
}
/**
* Populate the compare product list
*/
public function populate_products_list(){
global $sitepress;
/**
* WPML Support
*/
$lang = isset( $_REQUEST['lang'] ) ? $_REQUEST['lang'] : false;
// get cookie val
$the_list = isset( $_COOKIE[ $this->cookie_name ] ) ? json_decode( $_COOKIE[ $this->cookie_name ] ) : array();
// switch lang for WPML
if( defined( 'ICL_LANGUAGE_CODE' ) && $lang && isset( $sitepress ) ) {
$sitepress->switch_lang( $lang, true );
}
foreach( $the_list as $product_id ) {
if( function_exists( 'wpml_object_id_filter' ) ) {
$product_id_translated = wpml_object_id_filter( $product_id, 'product', false );
// get all product of current lang
if ( $product_id_translated !== $product_id ) {
continue;
}
}
// check for deleted|private products
$product = wc_get_product( $product_id );
if( ! $product || $product->post->post_status !== 'publish' ) {
continue;
}
$this->products_list[] = $product_id;
}
}
/**
* Enqueue the scripts and styles in the page
*/
public function enqueue_scripts() {
// scripts
$min = ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '.min' : '';
wp_register_script( 'yith-woocompare-main', YITH_WOOCOMPARE_ASSETS_URL . '/js/woocompare' . $min .'.js', array('jquery'), $this->version, true );
// enqueue and add localize
wp_enqueue_script( 'yith-woocompare-main' );
wp_localize_script( 'yith-woocompare-main', 'yith_woocompare', array(
'ajaxurl' => version_compare( WC()->version, '2.4', '>=' ) ? WC_AJAX::get_endpoint( "%%endpoint%%" ) : admin_url( 'admin-ajax.php', 'relative' ),
'actionadd' => $this->action_add,
'actionremove' => $this->action_remove,
'actionview' => $this->action_view,
'actionreload' => $this->action_reload,
'added_label' => apply_filters( 'yith_woocompare_compare_added_label', __( 'Added', 'yith-woocommerce-compare' ) ),
'table_title' => apply_filters( 'yith_woocompare_compare_table_title',__( 'Product Comparison', 'yith-woocommerce-compare' ) ),
'auto_open' => get_option( 'yith_woocompare_auto_open', 'yes' ),
'cookie_name' => $this->cookie_name
));
// colorbox
if( $this->page_or_popup == 'popup' ) {
wp_enqueue_style( 'jquery-colorbox', YITH_WOOCOMPARE_ASSETS_URL . '/css/colorbox.css' );
wp_enqueue_script( 'jquery-colorbox', YITH_WOOCOMPARE_ASSETS_URL . '/js/jquery.colorbox-min.js', array( 'jquery' ), '1.4.21', true );
}
// widget
if ( is_active_widget( false, false, 'yith-woocompare-widget', true ) && ! is_admin() ) {
wp_enqueue_style( 'yith-woocompare-widget', YITH_WOOCOMPARE_ASSETS_URL . '/css/widget.css' );
}
}
/**
* The fields to show in the table
*
* @param array $products
* @return mixed|void
* @since 1.0.0
*/
public function fields( $products = array() ) {
// get options
$fields = get_option( 'yith_woocompare_fields', array() );
$dynamic = get_option( 'yith_woocompare_dynamic_attributes' ) == 'yes';
$custom = get_option( 'yith_woocompare_custom_attributes' ) == 'yes';
// remove disabled attributes
$fields = array_filter( $fields );
foreach ( $fields as $key => $value ) {
// add if default
if ( isset( $this->default_fields[$key] ) ) {
$fields[ $key ] = $this->default_fields[$key];
}
// add if in options
elseif ( taxonomy_exists( $key ) && ! $dynamic ) {
$fields[ $key ] = wc_attribute_label( $key );
}
}
if( ! empty( $products ) && ( $dynamic || $custom ) ) {
foreach( $products as $product_id ) {
$product = wc_get_product( $product_id );
if( ! $product ) {
continue;
}
$attrs = $product->get_attributes();
foreach( $attrs as $key => $value ) {
// decode
$key = urldecode( $key );
if( ! isset( $value['is_taxonomy'] ) ||
( $value['is_taxonomy'] && ! array_key_exists( $key, $fields ) ) ||
( $value['is_taxonomy'] && ! $dynamic ) ||
( ! $value['is_taxonomy'] && ! $custom ) ) {
continue;
}
// add field
$fields[ $key ] = wc_attribute_label( $key );
}
}
if( $dynamic ) {
foreach( $fields as $key => $value ) {
if( $value === true ) {
unset( $fields[$key] );
}
}
}
}
return apply_filters( 'yith_woocompare_filter_table_fields', $fields, $products );
}
/**
* Render the maintenance page
*
*/
public function compare_table_html() {
if ( ( ! defined('DOING_AJAX') || ! DOING_AJAX ) && ( ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != $this->action_view ) ) return;
// check if is add to cart
if( isset( $_REQUEST['add-to-cart'] ) ) {
$product_id = intval( $_REQUEST['add-to-cart'] );
wp_redirect( get_permalink( $product_id ) );
exit;
}
global $woocommerce, $sitepress;
/**
* WPML Suppot: Localize Ajax Call
*/
$lang = isset( $_REQUEST['lang'] ) ? $_REQUEST['lang'] : false;
if( defined( 'ICL_LANGUAGE_CODE' ) && $lang && isset( $sitepress ) ) {
$sitepress->switch_lang( $lang, true );
}
$args = $this->_vars();
$args['share'] = false;
// remove all styles from compare template
add_action('wp_print_styles', array( $this, 'remove_all_styles' ), 100);
// remove admin bar
remove_action( 'wp_footer', 'wp_admin_bar_render', 1000 );
remove_action( 'wp_head', '_admin_bar_bump_cb' );
$plugin_path = YITH_WOOCOMPARE_TEMPLATE_PATH . '/' . $this->template_file;
if ( defined('WC_TEMPLATE_PATH') ) {
$template_path = get_template_directory() . '/' . WC_TEMPLATE_PATH . $this->template_file;
$child_path = get_stylesheet_directory() . '/' . WC_TEMPLATE_PATH . $this->template_file;
}
else {
$template_path = get_template_directory() . '/' . $woocommerce->template_url . $this->template_file;
$child_path = get_stylesheet_directory() . '/' . $woocommerce->template_url . $this->template_file;
}
foreach ( array( 'child_path', 'template_path', 'plugin_path' ) as $var ) {
if ( file_exists( ${$var} ) ) {
include ${$var};
exit();
}
}
}
/**
* Return the array with all products and all attributes values
*
* @param mixed $products
* @return array The complete list of products with all attributes value
*/
public function get_products_list( $products = array() ) {
$list = array();
$products = empty( $products ) ? $this->products_list : $products;
$products = apply_filters( 'yith_woocompare_exclude_products_from_list', $products );
$fields = $this->fields( $products );
foreach ( $products as $product_id ) {
$product = $this->wc_get_product( $product_id );
if ( ! $product )
continue;
$product->fields = array();
$custom_attributes = get_post_meta( $product->id, '_product_attributes', true );
// custom attributes
foreach ( $fields as $field => $name ) {
switch( $field ) {
case 'price':
$product->fields[$field] = $product->get_price_html();
break;
case 'description':
$description = ( get_option( 'yith_woocompare_use_full_description' ) == 'yes' ) ? $product->post->post_content : apply_filters( 'woocommerce_short_description', $product->post->post_excerpt );
$product->fields[$field] = apply_filters( 'yith_woocompare_products_description', $description );
break;
case 'stock':
$availability = $product->get_availability();
if ( empty( $availability['availability'] ) ) {
$availability['availability'] = __( 'In stock', 'yith-woocommerce-compare' );
}
$product->fields[$field] = sprintf( '%s', esc_html( $availability['availability'] ) );
break;
case 'weight':
if( $weight = $product->get_weight() ){
$weight = wc_format_localized_decimal( $weight ) . ' ' . esc_attr( get_option( 'woocommerce_weight_unit' ) );
}
else {
$weight = '-';
}
$product->fields[$field] = sprintf( '%s', esc_html( $weight ) );
break;
case 'dimensions':
if( ! $dimensions = $product->get_dimensions() ) {
$dimensions = '-';
}
$product->fields[$field] = sprintf( '%s', esc_html( $dimensions ) );
break;
default:
if ( taxonomy_exists( $field ) ) {
$product->fields[$field] = array();
$terms = get_the_terms( $product_id, $field );
if ( ! empty( $terms ) ) {
foreach ( $terms as $term ) {
$term = sanitize_term( $term, $field );
$product->fields[$field][] = $term->name;
}
}
$product->fields[$field] = implode( ', ', $product->fields[$field] );
}
elseif( $custom_attributes != false ) {
if( ! isset( $custom_attributes[$field] ) || ! is_array( $custom_attributes[$field] ) ) {
continue;
}
$current_custom_attribute = $custom_attributes[$field];
if( ! empty( $current_custom_attribute['value'] ) ) {
$product->fields[$field] = str_replace('|', ',', $current_custom_attribute['value'] );
}
}
else {
do_action_ref_array( 'yith_woocompare_field_' . $field, array( $product, &$product->fields ) );
}
break;
}
}
$list[] = $product;
}
return $list;
}
/**
* The URL of product comparison table
*
* @param bool | int $product_id
* @return string The url to add the product in the comparison table
*/
public function view_table_url( $product_id = false ) {
$url_args = array(
'action' => $this->action_view,
'iframe' => true
);
$lang = defined( 'ICL_LANGUAGE_CODE' ) ? ICL_LANGUAGE_CODE : false;
if( $lang ) {
$url_args['lang'] = $lang;
}
return apply_filters( 'yith_woocompare_view_table_url', esc_url_raw( add_query_arg( $url_args, site_url() ) ), $product_id );
}
/**
* The URL to add the product into the comparison table
*
* @param int $product_id ID of the product to add
* @return string The url to add the product in the comparison table
*/
public function add_product_url( $product_id ) {
$url_args = array(
'action' => $this->action_add,
'id' => $product_id
);
$lang = defined( 'ICL_LANGUAGE_CODE' ) ? ICL_LANGUAGE_CODE : false;
if( $lang ) {
$url_args['lang'] = $lang;
}
return apply_filters( 'yith_woocompare_add_product_url', esc_url_raw( add_query_arg( $url_args, site_url() ) ), $this->action_add );
}
/**
* The URL to remove the product into the comparison table
*
* @param $product_id The ID of the product to remove
* @return string The url to remove the product in the comparison table
*/
public function remove_product_url( $product_id ) {
$url_args = array(
'action' => $this->action_remove,
'id' => $product_id
);
return apply_filters( 'yith_woocompare_remove_product_url', esc_url_raw( add_query_arg( $url_args, site_url() ) ), $this->action_remove );
}
/**
* Add the link to compare
*/
public function add_compare_link( $product_id = false, $args = array() ) {
extract( $args );
if ( ! $product_id ) {
global $product;
$product_id = isset( $product->id ) ? $product->id : 0;
}
// return if product doesn't exist
if ( empty( $product_id ) || apply_filters( 'yith_woocompare_remove_compare_link_by_cat', false, $product_id ) )
return;
$is_button = ! isset( $button_or_link ) || ! $button_or_link ? get_option( 'yith_woocompare_is_button' ) : $button_or_link;
if ( ! isset( $button_text ) || $button_text == 'default' ) {
$button_text = get_option( 'yith_woocompare_button_text', __( 'Compare', 'yith-woocommerce-compare' ) );
}
// set class
$class = '';
if( in_array( $product_id, $this->products_list ) ) {
$categories = get_the_terms( $product_id, 'product_cat' );
$cat = array();
if( ! empty( $categories ) ) {
foreach( $categories as $category ) {
$cat[] = $category->term_id;
}
}
$link = $this->view_table_url( $product_id );
$class = 'added';
$button_text = get_option( 'yith_woocompare_button_text_added', __( 'View Compare', 'yith-woocommerce-compare' ) );
}
else {
$link = $this->add_product_url( $product_id );
}
// add button class
$class = $is_button == 'button' ? $class . ' ' . 'button' : $class;
printf( '%s', $link, $class, $product_id, $button_text );
}
/**
* Return the url of stylesheet position
*/
public function stylesheet_url() {
global $woocommerce;
$filename = 'compare-premium.css';
$plugin_path = array( 'path' => YITH_WOOCOMPARE_DIR . '/assets/css/style.css', 'url' => YITH_WOOCOMPARE_ASSETS_URL . '/css/style.css' );
if ( defined('WC_TEMPLATE_PATH') ) {
$template_path = array( 'path' => get_template_directory() . '/' . WC_TEMPLATE_PATH . $filename, 'url' => get_template_directory_uri() . '/' . WC_TEMPLATE_PATH . $filename );
$child_path = array( 'path' => get_stylesheet_directory() . '/' . WC_TEMPLATE_PATH . $filename, 'url' => get_stylesheet_directory_uri() . '/' . WC_TEMPLATE_PATH . $filename );
}
else {
$template_path = array( 'path' => get_template_directory() . '/' . $woocommerce->template_url . $filename, 'url' => get_template_directory_uri() . '/' . $woocommerce->template_url . $filename );
$child_path = array( 'path' => get_stylesheet_directory() . '/' . $woocommerce->template_url . $filename, 'url' => get_stylesheet_directory_uri() . '/' . $woocommerce->template_url . $filename );
}
foreach ( array( 'child_path', 'template_path', 'plugin_path' ) as $var ) {
if ( file_exists( ${$var}['path'] ) ) {
return ${$var}['url'];
}
}
}
/**
* Generate template vars
*
* @param array $products
* @return array
* @since 1.0.0
* @access protected
*/
protected function _vars( $products = array() ) {
// get product list
$products = $this->get_products_list( $products );
// get field list
$fields = $this->fields( $products );
$different = apply_filters( 'yith_woocompare_get_different_fields_value', $products );
$show_title = get_option( 'yith_woocompare_fields_product_info_title' ) == 'yes';
$show_image = get_option( 'yith_woocompare_fields_product_info_image' ) == 'yes';
$show_add_cart = get_option( 'yith_woocompare_fields_product_info_add_cart' ) == 'yes';
if( ! $show_title && ! $show_image && ! $show_add_cart ) {
unset( $fields['product_info'] );
}
$vars = array(
'products' => $products,
'fields' => $fields,
'show_image' => $show_image,
'show_title' => $show_title,
'show_add_cart' => $show_add_cart,
'repeat_price' => get_option( 'yith_woocompare_price_end' ),
'repeat_add_to_cart' => get_option( 'yith_woocompare_add_to_cart_end' ),
'different' => $different
);
return $vars;
}
/**
* The action called by the query string
*/
public function add_product_to_compare_action() {
if ( defined( 'DOING_AJAX' ) && DOING_AJAX || ! isset( $_REQUEST['id'] ) || ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != $this->action_add ) {
return;
}
$product_id = intval( $_REQUEST['id'] );
$product = $this->wc_get_product( $product_id );
// don't add the product if doesn't exist
if ( isset( $product->id ) && ! in_array( $product_id, $this->products_list ) ) {
$this->add_product_to_compare( $product_id );
}
wp_redirect( esc_url( remove_query_arg( array( 'id', 'action' ) ) ) );
exit();
}
/**
* The action called by AJAX
*/
public function add_product_to_compare_ajax() {
if( ! isset( $_REQUEST['id'] ) || ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != $this->action_add ){
die();
}
$product_id = intval( $_REQUEST['id'] );
$product = $this->wc_get_product( $product_id );
// don't add the product if doesn't exist
if ( isset( $product->id ) && ! in_array( $product_id, $this->products_list ) ) {
$this->add_product_to_compare( $product_id );
}
do_action( 'yith_woocompare_add_product_action_ajax' );
$json = array(
'table_url' => $this->view_table_url( $product_id ),
'widget_table' => $this->list_products_html(),
'only_one' => ( get_option( 'yith_woocompare_open_after_second' ) == 'yes' && count( $this->products_list ) <= 1 ) ? true : false
);
echo json_encode( $json );
die();
}
/**
* Add a product in the products comparison table
*
* @param int $product_id product ID to add in the comparison table
*/
public function add_product_to_compare( $product_id ) {
$this->products_list[] = $product_id;
setcookie( $this->cookie_name, json_encode( $this->products_list ), 0, COOKIEPATH, COOKIE_DOMAIN, false, false );
do_action( 'yith_woocompare_after_add_product', $product_id );
}
/**
* The action called by the query string
*/
public function remove_product_from_compare_action() {
if ( defined( 'DOING_AJAX' ) && DOING_AJAX || ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != $this->action_remove ) {
return;
}
$this->remove_product_from_compare( $_REQUEST['id'] );
// redirect
$redirect = esc_url( remove_query_arg( array( 'id', 'action' ) ) );
if ( isset( $_REQUEST['redirect'] ) && $_REQUEST['redirect'] == 'view' )
$redirect = esc_url( remove_query_arg( 'redirect', add_query_arg( 'action', $this->action_view, $redirect ) ) );
wp_redirect( $redirect );
exit();
}
/**
* The action called by AJAX
*/
public function remove_product_from_compare_ajax() {
if ( ! isset( $_REQUEST['id'] ) || ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != $this->action_remove ){
die();
}
$lang = isset( $_REQUEST['lang'] ) ? $_REQUEST['lang'] : false;
$this->remove_product_from_compare( $_REQUEST['id'] );
do_action( 'yith_woocompare_remove_product_action_ajax' );
header('Content-Type: text/html; charset=utf-8');
if ( isset( $_REQUEST['responseType'] ) && $_REQUEST['responseType'] == 'product_list' ) {
echo $this->list_products_html( $lang );
} else {
$this->compare_table_html();
}
die();
}
/**
* Return the list of widget table, used in AJAX
*/
public function reload_widget_list_ajax() {
if ( ! isset( $_REQUEST['action'] ) || $_REQUEST['action'] != $this->action_reload ){
die();
}
$lang = isset( $_REQUEST['lang'] ) ? $_REQUEST['lang'] : false;
echo $this->list_products_html( $lang );
die();
}
/**
* The list of products as HTML list
*/
public function list_products_html( $lang = false ) {
ob_start();
/**
* WPML Suppot: Localize Ajax Call
*/
global $sitepress;
if( defined( 'ICL_LANGUAGE_CODE' ) && $lang && isset( $sitepress )) {
$sitepress->switch_lang( $lang, true );
}
if ( empty( $this->products_list ) ) {
echo '' . __( 'No products to compare', 'yith-woocommerce-compare' ) . '';
return ob_get_clean();
}
foreach ( $this->products_list as $product_id ) {
$product = $this->wc_get_product( $product_id );
if ( ! $product )
continue;
?>
x
get_title() ?>
products_list, $this );
}
/**
* Remove a product from the comparison table
*
* @param $product_id The product ID to remove from the comparison table
*/
public function remove_product_from_compare( $product_id ) {
if( $product_id == 'all' ) {
$this->products_list = array();
}
else {
foreach ( $this->products_list as $k => $id ) {
if ( intval( $product_id ) == $id ) {
unset( $this->products_list[ $k ] );
}
}
}
setcookie( $this->cookie_name, json_encode( array_values( $this->products_list ) ), 0, COOKIEPATH, COOKIE_DOMAIN, false, false );
do_action( 'yith_woocompare_after_remove_product', $product_id );
}
/**
* Remove all styles from the compare template
*/
public function remove_all_styles() {
global $wp_styles;
$wp_styles->queue = array();
}
/**
* Show the html for the shortcode
*/
public function compare_button_sc( $atts, $content = null ) {
$atts = shortcode_atts(array(
'product' => false,
'type' => 'default',
'container' => 'yes'
), $atts);
$product_id = 0;
/**
* Retrieve the product ID in these steps:
* - If "product" attribute is not set, get the product ID of current product loop
* - If "product" contains ID, post slug or post title
*/
if ( ! $atts['product'] ) {
global $product;
$product_id = isset( $product->id ) ? $product->id : 0;
} else {
global $wpdb;
$product = $wpdb->get_row( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE ID = %d OR post_name = %s OR post_title = %s LIMIT 1", $atts['product'], $atts['product'], $atts['product'] ) );
if ( ! empty( $product ) ) {
$product_id = $product->ID;
}
}
// if product ID is 0, maybe the product doesn't exists or is wrong.. in this case, doesn't show the button
if ( empty( $product_id ) ) return;
ob_start();
if ( $atts['container'] == 'yes' ) echo '';
$this->add_compare_link( $product_id, array(
'button_or_link' => ( $atts['type'] == 'default' ? false : $atts['type'] ),
'button_text' => empty( $content ) ? 'default' : $content
) );
if ( $atts['container'] == 'yes' ) echo '
';
return ob_get_clean();
}
public function wc_get_product( $product_id ){
$wc_get_product = function_exists( 'wc_get_product' ) ? 'wc_get_product' : 'get_product';
return $wc_get_product( $product_id );
}
}
}