WC_Product_Dependencies

Plugin Name: WooCommerce Product Dependencies Plugin URI: http://somewherewarm.gr/ Description: Restrict access to WooCommerce products, depending on the ownership and/or purchase of other, prerequisite products.

Defined (1)

The class is defined in the following location(s).

/woocommerce-product-dependencies.php  
  1. class WC_Product_Dependencies { 
  2.  
  3.     /** 
  4.      * The single instance of the class. 
  5.      * @var WC_Product_Dependencies 
  6.      * 
  7.      * @since 1.1.0 
  8.      */ 
  9.     protected static $_instance = null; 
  10.  
  11.     /** 
  12.      * Required WC version. 
  13.      * @var string 
  14.      */ 
  15.     private $required = '2.2'; 
  16.  
  17.     /** 
  18.      * Main WC_Product_Dependencies instance. 
  19.      * 
  20.      * Ensures only one instance of WC_Product_Dependencies is loaded or can be loaded - @see 'WC_Product_Dependencies()'. 
  21.      * 
  22.      * @since  1.1.0 
  23.      * 
  24.      * @static 
  25.      * @return WC_Product_Dependencies - Main instance 
  26.      */ 
  27.     public static function instance() { 
  28.         if ( is_null( self::$_instance ) ) { 
  29.             self::$_instance = new self(); 
  30.         } 
  31.         return self::$_instance; 
  32.     } 
  33.  
  34.     /** 
  35.      * Cloning is forbidden. 
  36.      * 
  37.      * @since 1.1.0 
  38.      */ 
  39.     public function __clone() { 
  40.         _doing_it_wrong( __FUNCTION__, __( 'Foul!', 'woocommerce-product-dependencies' ), '1.1.0' ); 
  41.     } 
  42.  
  43.     /** 
  44.      * Unserializing instances of this class is forbidden. 
  45.      * 
  46.      * @since 1.1.0 
  47.      */ 
  48.     public function __wakeup() { 
  49.         _doing_it_wrong( __FUNCTION__, __( 'Foul!', 'woocommerce-product-dependencies' ), '1.1.0' ); 
  50.     } 
  51.  
  52.     /** 
  53.      * Fire in the hole! 
  54.      */ 
  55.     public function __construct() { 
  56.  
  57.         // Load plugin on 'plugins_loaded' hook. 
  58.         add_action( 'plugins_loaded', array( $this, 'plugins_loaded' ) ); 
  59.     } 
  60.  
  61.     /** 
  62.      * Initialize. 
  63.      * 
  64.      * @return void 
  65.      */ 
  66.     public function plugins_loaded() { 
  67.  
  68.         // Core compatibility functions. 
  69.         require_once( 'class-wc-pd-core-compatibility.php' ); 
  70.  
  71.         if ( ! function_exists( 'WC' ) || ! WC_PD_Core_Compatibility::is_wc_version_gte_2_2() ) { 
  72.             return; 
  73.         } 
  74.  
  75.         // Helper functions. 
  76.         require_once( 'class-wc-pd-helpers.php' ); 
  77.  
  78.         // Init textdomain. 
  79.         add_action( 'init', array( $this, 'init') ); 
  80.  
  81.         // Validate add-to-cart action. 
  82.         add_filter( 'woocommerce_add_to_cart_validation', array( $this, 'add_to_cart_validation' ), 10, 3 ); 
  83.  
  84.         // Validate products in cart. 
  85.         add_action( 'woocommerce_check_cart_items', array( $this, 'check_cart_items' ), 1 ); 
  86.  
  87.         if ( is_admin() ) { 
  88.  
  89.             // Save admin options. 
  90.             if ( WC_PD_Core_Compatibility::is_wc_version_gte_2_7() ) { 
  91.                 add_action( 'woocommerce_admin_process_product_object', array( $this, 'process_product_data' ) ); 
  92.             } else { 
  93.                 add_action( 'woocommerce_process_product_meta', array( $this, 'process_meta' ), 10, 2 ); 
  94.             } 
  95.  
  96.             // Add the "Dependencies" tab in Product Data. 
  97.             if ( WC_PD_Core_Compatibility::is_wc_version_gte_2_5() ) { 
  98.                 add_action( 'woocommerce_product_data_tabs', array( __CLASS__, 'dependencies_product_data_tab' ) ); 
  99.             } else { 
  100.                 add_action( 'woocommerce_product_write_panel_tabs', array( $this, 'dependencies_product_data_panel_tab' ) ); 
  101.             } 
  102.  
  103.             // Add the "Dependencies" tab content in Product Data. 
  104.             if ( WC_PD_Core_Compatibility::is_wc_version_gte_2_7() ) { 
  105.                 add_action( 'woocommerce_product_data_panels', array( $this, 'dependencies_product_data_panel' ) ); 
  106.             } else { 
  107.                 add_action( 'woocommerce_product_write_panels', array( $this, 'dependencies_product_data_panel' ) ); 
  108.             } 
  109.         } 
  110.     } 
  111.  
  112.     /** 
  113.      * Init textdomain. 
  114.      * 
  115.      * @return void 
  116.      */ 
  117.     public function init() { 
  118.         load_plugin_textdomain( 'woocommerce-product-dependencies', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' ); 
  119.     } 
  120.  
  121.     /** 
  122.      * Validates a product when adding to cart. 
  123.      * 
  124.      * @param  boolean  $add 
  125.      * @param  int      $item_id 
  126.      * @param  int      $quantity 
  127.      * @return boolean 
  128.      */ 
  129.     public function add_to_cart_validation( $add, $item_id, $quantity ) { 
  130.  
  131.         return $add && $this->evaluate_dependencies( $item_id ); 
  132.     } 
  133.  
  134.     /** 
  135.      * Validates cart contents. 
  136.      */ 
  137.     public function check_cart_items() { 
  138.  
  139.         $cart_items = WC()->cart->cart_contents; 
  140.  
  141.         foreach ( $cart_items as $cart_item ) { 
  142.  
  143.             $product = $cart_item[ 'data' ]; 
  144.  
  145.             $this->evaluate_dependencies( $product ); 
  146.         } 
  147.     } 
  148.  
  149.     /** 
  150.      * Check conditions. 
  151.      * 
  152.      * @param  mixed  $item 
  153.      * @return boolean 
  154.      */ 
  155.     public function evaluate_dependencies( $item ) { 
  156.  
  157.         if ( is_a( $item, 'WC_Product' ) ) { 
  158.             $product = $item; 
  159.             $product_id = $product->is_type( 'variation' ) ? WC_PD_Core_Compatibility::get_parent_id( $product ) : WC_PD_Core_Compatibility::get_id( $product ); 
  160.         } else { 
  161.             $product_id = absint( $item ); 
  162.             $product = wc_get_product( $product_id ); 
  163.         } 
  164.  
  165.         if ( ! $product ) { 
  166.             return; 
  167.         } 
  168.  
  169.         if ( WC_PD_Core_Compatibility::is_wc_version_gte_2_7() ) { 
  170.             $tied_product_ids = $product->get_meta( '_tied_products', true ); 
  171.             $dependency_type = absint( $product->get_meta( '_dependency_type', true ) ); 
  172.         } else { 
  173.             $tied_product_ids = (array) get_post_meta( $product_id, '_tied_products', true ); 
  174.             $dependency_type = absint( get_post_meta( $product_id, '_dependency_type', true ) ); 
  175.         } 
  176.  
  177.         $product_title = $product->get_title(); 
  178.         $tied_products = array(); 
  179.  
  180.         // Ensure dependencies exist and are purchasable. 
  181.         if ( ! empty( $tied_product_ids ) ) { 
  182.             foreach ( $tied_product_ids as $id ) { 
  183.                 $tied_product = wc_get_product( $id ); 
  184.                 if ( $tied_product && $tied_product->is_purchasable() ) { 
  185.                     $tied_products[ $id ] = $tied_product; 
  186.                 } 
  187.             } 
  188.         } 
  189.  
  190.         if ( ! empty( $tied_products ) ) { 
  191.  
  192.             $tied_product_ids = array_keys( $tied_products ); 
  193.  
  194.             // Check cart. 
  195.             if ( $dependency_type === 2 || $dependency_type === 3 ) { 
  196.  
  197.                 $cart_contents = WC()->cart->cart_contents; 
  198.  
  199.                 foreach ( $cart_contents as $cart_item ) { 
  200.                     $product_id = $cart_item[ 'product_id' ]; 
  201.                     $variation_id = $cart_item[ 'variation_id' ]; 
  202.                     if ( in_array( $product_id, $tied_product_ids ) || in_array( $variation_id, $tied_product_ids ) ) { 
  203.                         return true; 
  204.                     } 
  205.                 } 
  206.             } 
  207.  
  208.             // Check ownership. 
  209.             if ( is_user_logged_in() && ( $dependency_type === 1 || $dependency_type === 3 ) ) { 
  210.  
  211.                 $current_user = wp_get_current_user(); 
  212.                 $is_owner = false; 
  213.  
  214.                 foreach ( $tied_product_ids as $id ) { 
  215.                     if ( wc_customer_bought_product( $current_user->user_email, $current_user->ID, $id ) ) { 
  216.                         $is_owner = true; 
  217.                     } 
  218.                 } 
  219.  
  220.                 if ( ! $is_owner ) { 
  221.  
  222.                     $merged_titles = WC_PD_Helpers::merge_product_titles( $tied_products ); 
  223.  
  224.                     if ( $dependency_type === 1 ) { 
  225.                         wc_add_notice( sprintf( __( 'Access to "%2$s" is restricted only to verified owners of %1$s.', 'woocommerce-product-dependencies' ), $merged_titles, $product_title ), 'error' ); 
  226.                     } else { 
  227.                         wc_add_notice( sprintf( __( 'Access to "%2$s" is restricted only to verified owners of %1$s. Alternatively, access to this item will be granted after adding a %1$s to the cart.', 'woocommerce-product-dependencies' ), $merged_titles, $product_title ), 'error' ); 
  228.                     } 
  229.                     return false; 
  230.                 } 
  231.  
  232.             } else { 
  233.  
  234.                 $merged_titles = WC_PD_Helpers::merge_product_titles( $tied_products ); 
  235.  
  236.                 $msg = ''; 
  237.  
  238.                 if ( $dependency_type === 1 ) { 
  239.                     $msg = __( 'Access to "%2$s" is restricted only to verified owners of %1$s. The verification is automatic and simply requires you to be <a href="%3$s">logged in</a>.', 'woocommerce-product-dependencies' ); 
  240.                 } elseif ( $dependency_type === 2 ) { 
  241.                     $msg = __( '"%2$s" can be purchased only in combination with %1$s. Access to this item will be granted after adding a %1$s to the cart.', 'woocommerce-product-dependencies' ); 
  242.                 } else { 
  243.                     $msg = __( '"%2$s" requires the purchase of %1$s. Ownership can be verified by simply <a href="%3$s">logging in</a>. Alternatively, access to this item will be granted after adding a %1$s to the cart.', 'woocommerce-product-dependencies' ); 
  244.                 } 
  245.  
  246.                 wc_add_notice( sprintf( $msg, $merged_titles, $product_title, wp_login_url() ), 'error' ); 
  247.  
  248.                 return false; 
  249.             } 
  250.         } 
  251.  
  252.         return true; 
  253.     } 
  254.  
  255.     /** 
  256.     |-------------------------------------------------------------------------- 
  257.     | Admin Filters. 
  258.     |-------------------------------------------------------------------------- 
  259.     */ 
  260.  
  261.     /** 
  262.      * Add Product Data tab. 
  263.      * 
  264.      * @return void 
  265.      */ 
  266.     public function dependencies_product_data_panel_tab() { 
  267.         echo '<li class="tied_products_tab related_product_options linked_product_options"><a href="#tied_products_data">' . __( 'Dependencies', 'woocommerce-product-dependencies' ) . '</a></li>'; 
  268.     } 
  269.  
  270.     /** 
  271.      * Add the "Bundled Products" panel tab. 
  272.      * @param  array  $tabs 
  273.      * @return array 
  274.      */ 
  275.     public static function dependencies_product_data_tab( $tabs ) { 
  276.  
  277.         $tabs[ 'dependencies' ] = array( 
  278.             'label' => __( 'Dependencies', 'woocommerce-product-dependencies' ),  
  279.             'target' => 'tied_products_data',  
  280.             'class' => array( 'show_if_simple', 'show_if_variable', 'show_if_bundle', 'show_if_composite', 'linked_product_options' ) 
  281.  ); 
  282.  
  283.         return $tabs; 
  284.     } 
  285.  
  286.     /** 
  287.      * Add Product Data tab section. 
  288.      * 
  289.      * @return void 
  290.      */ 
  291.     public function dependencies_product_data_panel() { 
  292.  
  293.         global $post, $product_object; 
  294.  
  295.         if ( WC_PD_Core_Compatibility::is_wc_version_gte_2_7() ) { 
  296.             $tied_products = $product_object->get_meta( '_tied_products', true ); 
  297.             $dependency_type = $product_object->get_meta( '_dependency_type', true ); 
  298.         } else { 
  299.             $tied_products = get_post_meta( $post->ID, '_tied_products', true ); 
  300.             $dependency_type = get_post_meta( $post->ID, '_dependency_type', true ); 
  301.         } 
  302.  
  303.         if ( ! $dependency_type ) { 
  304.             $dependency_type = 3; 
  305.         } 
  306.  
  307.         $product_id_options = array(); 
  308.  
  309.         if ( $tied_products ) { 
  310.             foreach ( $tied_products as $item_id ) { 
  311.  
  312.                 $title = WC_PD_Helpers::get_product_title( $item_id ); 
  313.  
  314.                 if ( $title ) { 
  315.                     $product_id_options[ $item_id ] = $title; 
  316.                 } 
  317.             } 
  318.         } 
  319.  
  320.         ?> 
  321.         <div id="tied_products_data" class="panel woocommerce_options_panel wc-metaboxes-wrapper"> 
  322.  
  323.             <p class="form-field"> 
  324.                 <label> 
  325.                     <?php _e( 'Product Dependencies', 'woocommerce-product-dependencies' ); ?> 
  326.                 </label><?php 
  327.  
  328.                 if ( WC_PD_Core_Compatibility::is_wc_version_gte_2_7() ) { 
  329.  
  330.                     ?><select id="tied_products" name="tied_products[]" class="wc-product-search" multiple="multiple" style="width: 75%;" data-limit="500" data-action="woocommerce_json_search_products_and_variations" data-placeholder="<?php echo  __( 'Search for products and variations…', 'woocommerce-product-dependencies' ); ?>"><?php 
  331.  
  332.                         if ( ! empty( $product_id_options ) ) { 
  333.  
  334.                             foreach ( $product_id_options as $product_id => $product_name ) { 
  335.                                 echo '<option value="' . $product_id . '" selected="selected">' . $product_name . '</option>'; 
  336.                             } 
  337.                         } 
  338.  
  339.                     ?></select><?php 
  340.  
  341.                 } elseif ( WC_PD_Core_Compatibility::is_wc_version_gte_2_3() ) { 
  342.  
  343.                     ?><input type="hidden" id="tied_products" name="tied_products" class="wc-product-search" style="width: 75%;" data-placeholder="<?php _e( 'Search for products…', 'woocommerce-product-dependencies' ); ?>" data-action="woocommerce_json_search_products" data-multiple="true" data-selected="<?php 
  344.  
  345.                         echo esc_attr( json_encode( $product_id_options ) ); 
  346.  
  347.                     ?>" value="<?php echo implode( ', ', array_keys( $product_id_options ) ); ?>" /><?php 
  348.  
  349.                 } else { 
  350.  
  351.                     ?><select id="tied_products" multiple="multiple" name="tied_products[]" data-placeholder="<?php _e( 'Search for products…', 'woocommerce-product-dependencies' ); ?>" class="ajax_chosen_select_products"><?php 
  352.  
  353.                         if ( ! empty( $product_id_options ) ) { 
  354.                             foreach ( $product_id_options as $product_id => $product_name ) { 
  355.                                 echo '<option value="' . $product_id . '" selected="selected">' . $product_name . '</option>'; 
  356.                             } 
  357.                         } 
  358.                     ?></select><?php 
  359.  
  360.                 } 
  361.  
  362.                 echo WC_PD_Core_Compatibility::wc_help_tip( __( 'Restrict product access based on the ownership or purchase of <strong>any</strong> product or variation added to this list.', 'woocommerce-product-dependencies' ) ); 
  363.  
  364.                 ?> 
  365.             </p> 
  366.             <p class="form-field"> 
  367.                 <label><?php _e( 'Dependency Type', 'woocommerce-product-dependencies' ); ?> 
  368.                 </label> 
  369.                 <select name="dependency_type" id="dependency_type" style="min-width:150px;"> 
  370.                     <option value="1" <?php echo $dependency_type == 1 ? 'selected="selected"' : ''; ?>><?php _e( 'Ownership', 'woocommerce-product-dependencies' ); ?></option> 
  371.                     <option value="2" <?php echo $dependency_type == 2 ? 'selected="selected"' : ''; ?>><?php _e( 'Purchase', 'woocommerce-product-dependencies' ); ?></option> 
  372.                     <option value="3" <?php echo $dependency_type == 3 ? 'selected="selected"' : ''; ?>><?php _e( 'Either', 'woocommerce-product-dependencies' ); ?></option> 
  373.                 </select> 
  374.             </p> 
  375.         </div> 
  376.     <?php 
  377.     } 
  378.  
  379.     /** 
  380.      * Save dependencies data. WC >= 2.7. 
  381.      * 
  382.      * @param  WC_Product  $product 
  383.      * @return void 
  384.      */ 
  385.     public function process_product_data( $product ) { 
  386.  
  387.         if ( ! isset( $_POST[ 'tied_products' ] ) || empty( $_POST[ 'tied_products' ] ) ) { 
  388.  
  389.             $product->delete_meta_data( '_tied_products' ); 
  390.  
  391.         } elseif ( isset( $_POST[ 'tied_products' ] ) && ! empty( $_POST[ 'tied_products' ] ) ) { 
  392.  
  393.             $tied_ids = $_POST[ 'tied_products' ]; 
  394.  
  395.             if ( is_array( $tied_ids ) ) { 
  396.                 $tied_ids = array_map( 'intval', $tied_ids ); 
  397.             } else { 
  398.                 $tied_ids = array_filter( array_map( 'intval', explode( ', ', $tied_ids ) ) ); 
  399.             } 
  400.  
  401.             $product->add_meta_data( '_tied_products', $tied_ids, true ); 
  402.         } 
  403.  
  404.         if ( isset( $_POST[ 'dependency_type' ] ) && ! empty( $_POST[ 'dependency_type' ] ) ) { 
  405.             $product->add_meta_data( '_dependency_type', stripslashes( $_POST[ 'dependency_type' ] ), true ); 
  406.         } 
  407.     } 
  408.  
  409.     /** 
  410.      * Save dependencies meta. WC <= 2.6. 
  411.      * 
  412.      * @param  int      $post_id 
  413.      * @param  WC_Post  $post 
  414.      * @return void 
  415.      */ 
  416.     public function process_meta( $post_id, $post ) { 
  417.  
  418.         global $post; 
  419.  
  420.         if ( ! isset( $_POST[ 'tied_products' ] ) || empty( $_POST[ 'tied_products' ] ) ) { 
  421.  
  422.             delete_post_meta( $post_id, '_tied_products' ); 
  423.  
  424.         } elseif ( isset( $_POST[ 'tied_products' ] ) && ! empty( $_POST[ 'tied_products' ] ) ) { 
  425.  
  426.             $tied_ids = $_POST[ 'tied_products' ]; 
  427.  
  428.             if ( is_array( $tied_ids ) ) { 
  429.                 $tied_ids = array_map( 'intval', $tied_ids ); 
  430.             } else { 
  431.                 $tied_ids = array_filter( array_map( 'intval', explode( ', ', $tied_ids ) ) ); 
  432.             } 
  433.  
  434.             update_post_meta( $post_id, '_tied_products', $tied_ids ); 
  435.         } 
  436.  
  437.         if ( isset( $_POST[ 'dependency_type' ] ) && ! empty( $_POST[ 'dependency_type' ] ) ) { 
  438.             update_post_meta( $post_id, '_dependency_type', stripslashes( $_POST[ 'dependency_type' ] ) ); 
  439.         } 
  440.     } 
  441.  
  442.     /** 
  443.     |-------------------------------------------------------------------------- 
  444.     | Deprecated methods. 
  445.     |-------------------------------------------------------------------------- 
  446.     */ 
  447.  
  448.     /** 
  449.      * Check conditions. 
  450.      * 
  451.      * @deprecated  1.1.0 
  452.      * 
  453.      * @param  int  $item_id 
  454.      * @return boolean 
  455.      */ 
  456.     public function woo_tied_evaluate_access( $id ) { 
  457.         _deprecated_function( __METHOD__ . '()', '1.1.0', __CLASS__ . '::evaluate_access()' ); 
  458.         return WC_Product_Dependencies()->evaluate_dependencies( $id ); 
  459.     } 
  460. }