WC_Jamef

WC_Jamef class.

Defined (1)

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

/includes/class-wc-jamef.php  
  1. class WC_Jamef extends WC_Shipping_Method { 
  2.  
  3.     /** 
  4.      * Initialize the Jamef shipping method. 
  5.      * 
  6.      * @return void 
  7.      */ 
  8.     public function __construct() { 
  9.         $this->id = 'jamef'; 
  10.         $this->method_title = __( 'Jamef', 'wcjamef' ); 
  11.         $this->init(); 
  12.     } 
  13.  
  14.     /** 
  15.      * Initializes the method. 
  16.      * 
  17.      * @return void 
  18.      */ 
  19.     public function init() { 
  20.         // Jamef Web Service. 
  21.         $this->webservice = 'http://www.jamef.com.br/jamef/cotacaoFrete.do?eCommerce=true&'; 
  22.  
  23.         // Load the form fields. 
  24.         $this->init_form_fields(); 
  25.  
  26.         // Load the settings. 
  27.         $this->init_settings(); 
  28.  
  29.         // Define user set variables. 
  30.         $this->enabled = $this->settings['enabled']; 
  31.         $this->title = $this->settings['title']; 
  32.         //$this->declare_value = $this->settings['declare_value']; 
  33.         //$this->display_date = $this->settings['display_date']; 
  34.         //$this->additional_time = $this->settings['additional_time']; 
  35.         $this->availability = $this->settings['availability']; 
  36.         $this->fee = $this->settings['fee']; 
  37.         $this->zip_origin = $this->settings['zip_origin']; 
  38.         $this->countries = $this->settings['countries']; 
  39.         $this->corporate_service = $this->settings['corporate_service']; 
  40.         $this->minimum_height = $this->settings['minimum_height']; 
  41.         $this->minimum_width = $this->settings['minimum_width']; 
  42.         $this->minimum_length = $this->settings['minimum_length']; 
  43.         $this->debug = $this->settings['debug']; 
  44.  
  45.         // Active logs. 
  46.         if ( 'yes' == $this->debug ) { 
  47.             if ( class_exists( 'WC_Logger' ) ) { 
  48.                 $this->log = new WC_Logger(); 
  49.             } else { 
  50.                 $this->log = $this->woocommerce_method()->logger(); 
  51.             } 
  52.         } 
  53.  
  54.         // Actions. 
  55.         add_action( 'woocommerce_update_options_shipping_' . $this->id, array( &$this, 'process_admin_options' ) ); 
  56.     } 
  57.  
  58.     /** 
  59.      * Backwards compatibility with version prior to 2.1. 
  60.      * 
  61.      * @return object Returns the main instance of WooCommerce class. 
  62.      */ 
  63.     protected function woocommerce_method() { 
  64.         if ( function_exists( 'WC' ) ) { 
  65.             return WC(); 
  66.         } else { 
  67.             global $woocommerce; 
  68.             return $woocommerce; 
  69.         } 
  70.     } 
  71.  
  72.     /** 
  73.      * Admin options fields. 
  74.      * 
  75.      * @return void 
  76.      */ 
  77.     public function init_form_fields() { 
  78.         $this->form_fields = array( 
  79.             'enabled' => array( 
  80.                 'title' => __( 'Enable/Disable', 'wcjamef' ),  
  81.                 'type' => 'checkbox',  
  82.                 'label' => __( 'Enable this shipping method', 'wcjamef' ),  
  83.                 'default' => 'no' 
  84.  ),  
  85.             'title' => array( 
  86.                 'title' => __( 'Title', 'wcjamef' ),  
  87.                 'type' => 'text',  
  88.                 'description' => __( 'This controls the title which the user sees during checkout.', 'wcjamef' ),  
  89.                 'desc_tip' => true,  
  90.                 'default' => __( 'Jamef', 'wcjamef' ) 
  91.  ),  
  92.             'availability' => array( 
  93.                 'title' => __( 'Availability', 'wcjamef' ),  
  94.                 'type' => 'select',  
  95.                 'default' => 'all',  
  96.                 'class' => 'availability',  
  97.                 'options' => array( 
  98.                     'all' => __( 'All allowed countries', 'wcjamef' ),  
  99.                     'specific' => __( 'Specific Countries', 'wcjamef' ) 
  100.  ) 
  101.  ),  
  102.             'countries' => array( 
  103.                 'title' => __( 'Specific Countries', 'wcjamef' ),  
  104.                 'type' => 'multiselect',  
  105.                 'class' => 'chosen_select',  
  106.                 'css' => 'width: 450px;',  
  107.                 'options' => $this->woocommerce_method()->countries->countries 
  108.  ),  
  109.             'cnpj' => array( 
  110.                 'title' => __( 'CNPJ', 'wcjamef' ),  
  111.                 'type' => 'text',  
  112.                 'default' => '05549856000134' 
  113.  ),  
  114.             'unit_origin' => array( 
  115.                 'title' => __( 'Origin unit', 'wcjamef' ),  
  116.                 'type' => 'select',  
  117.                 'description' => __( 'Jamef unit from where the requests are sent.', 'wcjamef' ),  
  118.                 'desc_tip' => true,  
  119.                 'options' => array( 
  120.                     174 => 'Aracaju (AJU)',  
  121.                     122 => 'Barueri (BAR)',  
  122.                     111 => 'Bauru (BAU)',  
  123.                     1 => 'Belo Horizonte (BHZ)',  
  124.                     13 => 'Blumenau (BNU)',  
  125.                     163 => 'Braslia (BSB)',  
  126.                     160 => 'Cricima (CSM)',  
  127.                     12 => 'Campinas (CPQ)',  
  128.                     5 => 'Caxias do Sul (CXJ)',  
  129.                     10 => 'Curitiba (CWB)',  
  130.                     204 => 'Divinpolis (DIV)',  
  131.                     192 => 'Feira de Santana (FES)',  
  132.                     11 => 'Florianpolis (FLN)',  
  133.                     177 => 'Fortaleza (FOR)',  
  134.                     148 => 'Goinia (GYN)',  
  135.                     4 => 'Jaragu do Sul (JAS)',  
  136.                     208 => 'Juz de Fora (JDF)',  
  137.                     9 => 'Joinville (JOI)',  
  138.                     8 => 'Londrina (LDB)',  
  139.                     149 => 'Manaus (MAO)',  
  140.                     183 => 'Macei (MCZ)',  
  141.                     112 => 'Maring (MGF)',  
  142.                     191 => 'Natal (NAT)',  
  143.                     14 => 'Porto Alegre (POA)',  
  144.                     159 => 'Pouso Alegre (PSA)',  
  145.                     121 => 'Ribeiro Preto (RAO)',  
  146.                     171 => 'Recife (REC)',  
  147.                     3 => 'Rio de Janeiro (RIO)',  
  148.                     2 => 'So Paulo (SAO)',  
  149.                     125 => 'So Jos dos Campos (SJK)',  
  150.                     124 => 'So Jos do Rio Preto (SJP)',  
  151.                     168 => 'Salvador (SSA)',  
  152.                     109 => 'Uberlndia (UDI)',  
  153.                     209 => 'Vitria da Conquista (VDC)',  
  154.                     7 => 'Vitria (VIX)' 
  155.  ) 
  156.  ),  
  157.             'state_origin' => array( 
  158.                 'title' => __( 'Origin state', 'wcjamef' ),  
  159.                 'type' => 'select',  
  160.                 'css' => 'width: 250px;',  
  161.                 'default' => 'SP',  
  162.                 'options' => $this->woocommerce_method()->countries->states['BR'] 
  163.  ),  
  164.             /**'declare_value' => array( 
  165.                 'title' => __( 'Declare value', 'wcjamef' ),  
  166.                 'type' => 'select',  
  167.                 'default' => 'none',  
  168.                 'options' => array( 
  169.                     'declare' => __( 'Declare', 'wcjamef' ),  
  170.                     'none' => __( 'None', 'wcjamef' ) 
  171.  ),  
  172.  ),  
  173.             'display_date' => array( 
  174.                 'title' => __( 'Estimated delivery', 'wcjamef' ),  
  175.                 'type' => 'checkbox',  
  176.                 'label' => __( 'Enable', 'wcjamef' ),  
  177.                 'description' => __( 'Display date of estimated delivery.', 'wcjamef' ),  
  178.                 'desc_tip' => true,  
  179.                 'default' => 'no' 
  180.  ),  
  181.             'additional_time' => array( 
  182.                 'title' => __( 'Additional days', 'wcjamef' ),  
  183.                 'type' => 'text',  
  184.                 'description' => __( 'Additional days to the estimated delivery.', 'wcjamef' ),  
  185.                 'desc_tip' => true,  
  186.                 'default' => '0',  
  187.                 'placeholder' => '0' 
  188.  ), */ 
  189.             'fee' => array( 
  190.                 'title' => __( 'Handling Fee', 'wcjamef' ),  
  191.                 'type' => 'text',  
  192.                 'description' => __( 'Enter an amount, e.g. 2.50, or a percentage, e.g. 5%. Leave blank to disable.', 'wcjamef' ),  
  193.                 'desc_tip' => true,  
  194.                 'placeholder' => '0.00' 
  195.  ),  
  196.             'package_standard' => array( 
  197.                 'title' => __( 'Package Standard', 'wcjamef' ),  
  198.                 'type' => 'title',  
  199.                 'description' => __( 'Sets a minimum measure for the package.', 'wcjamef' ),  
  200.                 'desc_tip' => true,  
  201.  ),  
  202.             'minimum_height' => array( 
  203.                 'title' => __( 'Minimum Height', 'wcjamef' ),  
  204.                 'type' => 'text',  
  205.                 'description' => __( 'Minimum height of the package. Jamef needs at least 2 cm.', 'wcjamef' ),  
  206.                 'desc_tip' => true,  
  207.                 'default' => '2' 
  208.  ),  
  209.             'minimum_width' => array( 
  210.                 'title' => __( 'Minimum Width', 'wcjamef' ),  
  211.                 'type' => 'text',  
  212.                 'description' => __( 'Minimum width of the package. Jamef needs at least 11 cm.', 'wcjamef' ),  
  213.                 'desc_tip' => true,  
  214.                 'default' => '11' 
  215.  ),  
  216.             'minimum_length' => array( 
  217.                 'title' => __( 'Minimum Length', 'wcjamef' ),  
  218.                 'type' => 'text',  
  219.                 'description' => __( 'Minimum length of the package. Jamef needs at least 16 cm.', 'wcjamef' ),  
  220.                 'desc_tip' => true,  
  221.                 'default' => '16' 
  222.  ),  
  223.             'testing' => array( 
  224.                 'title' => __( 'Testing', 'wcjamef' ),  
  225.                 'type' => 'title' 
  226.  ),  
  227.             'debug' => array( 
  228.                 'title' => __( 'Debug Log', 'wcjamef' ),  
  229.                 'type' => 'checkbox',  
  230.                 'label' => __( 'Enable logging', 'wcjamef' ),  
  231.                 'default' => 'no',  
  232.                 'description' => sprintf( __( 'Log Jamef events, such as WebServices requests, inside %s.', 'wcjamef' ), '<code>woocommerce/logs/jamef-' . sanitize_file_name( wp_hash( 'jamef' ) ) . '.txt</code>' ) 
  233.  ) 
  234.  ); 
  235.     } 
  236.  
  237.     /** 
  238.      * Jamef options page. 
  239.      * 
  240.      * @return void 
  241.      */ 
  242.     public function admin_options() { 
  243.         // Call the admin scripts. 
  244.         //wp_enqueue_script( 'wc-jamef', WOO_JAMEF_URL . 'js/admin.js', array( 'jquery' ), '', true ); 
  245.  
  246.         echo '<h3>' . $this->method_title . '</h3>'; 
  247.         echo '<p>' . __( 'Jamef is a brazilian delivery method.', 'wcjamef' ) . '</p>'; 
  248.         echo '<table class="form-table">'; 
  249.             $this->generate_settings_html(); 
  250.         echo '</table>'; 
  251.     } 
  252.  
  253.     /** 
  254.      * Checks if the method is available. 
  255.      * 
  256.      * @param array $package Order package. 
  257.      * 
  258.      * @return bool 
  259.      */ 
  260.     public function is_available( $package ) { 
  261.         $is_available = true; 
  262.  
  263.         if ( 'no' == $this->enabled ) { 
  264.             $is_available = false; 
  265.         } else { 
  266.             $ship_to_countries = ''; 
  267.  
  268.             if ( 'specific' == $this->availability ) { 
  269.                 $ship_to_countries = $this->countries; 
  270.             } elseif ( 'specific' == get_option( 'woocommerce_allowed_countries' ) ) { 
  271.                 $ship_to_countries = get_option( 'woocommerce_specific_allowed_countries' ); 
  272.             } 
  273.  
  274.             if ( is_array( $ship_to_countries ) && ! in_array( $package['destination']['country'], $ship_to_countries ) ) { 
  275.                 $is_available = false; 
  276.             } 
  277.         } 
  278.  
  279.         return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', $is_available, $package ); 
  280.     } 
  281.  
  282.     /** 
  283.      * Replace comma by dot. 
  284.      * 
  285.      * @param  mixed $value Value to fix. 
  286.      * 
  287.      * @return mixed 
  288.      */ 
  289.     private function fix_format( $value ) { 
  290.         $value = str_replace( ', ', '.', $value ); 
  291.  
  292.         return $value; 
  293.     } 
  294.  
  295.     /** 
  296.      * Fix number format for SimpleXML. 
  297.      * 
  298.      * @param  float $value  Value with dot. 
  299.      * 
  300.      * @return string        Value with comma. 
  301.      */ 
  302.     private function fix_simplexml_format( $value ) { 
  303.         $value = str_replace( '.', ', ', $value ); 
  304.  
  305.         return $value; 
  306.     } 
  307.  
  308.     /** 
  309.      * Fix Zip Code format. 
  310.      * 
  311.      * @param mixed $zip Zip Code. 
  312.      * 
  313.      * @return int 
  314.      */ 
  315.     protected function fix_zip_code( $zip ) { 
  316.         $fixed = preg_replace( '([^0-9])', '', $zip ); 
  317.  
  318.         return $fixed; 
  319.     } 
  320.  
  321.     /** 
  322.      * Get fee. 
  323.      * 
  324.      * @param  mixed $fee 
  325.      * @param  mixed $total 
  326.      * 
  327.      * @return float 
  328.      */ 
  329.     public function get_fee( $fee, $total ) { 
  330.         if ( strstr( $fee, '%' ) ) { 
  331.             $fee = ( $total / 100 ) * str_replace( '%', '', $fee ); 
  332.         } 
  333.  
  334.         return $fee; 
  335.     } 
  336.  
  337.     /** 
  338.      * Extracts the weight and dimensions from the order. 
  339.      * 
  340.      * @param array $package 
  341.      * 
  342.      * @return array 
  343.      */ 
  344.     protected function measures_extract( $package ) { 
  345.         $count = 0; 
  346.         $height = array(); 
  347.         $width = array(); 
  348.         $length = array(); 
  349.         $weight = array(); 
  350.  
  351.         // Shipping per item. 
  352.         foreach ( $package['contents'] as $item_id => $values ) { 
  353.             $product = $values['data']; 
  354.             $qty = $values['quantity']; 
  355.  
  356.             if ( $qty > 0 && $product->needs_shipping() ) { 
  357.  
  358.                 if ( version_compare( WOOCOMMERCE_VERSION, '2.1', '>=' ) ) { 
  359.                     $_height = wc_get_dimension( $this->fix_format( $product->height ), 'cm' ); 
  360.                     $_width = wc_get_dimension( $this->fix_format( $product->width ), 'cm' ); 
  361.                     $_length = wc_get_dimension( $this->fix_format( $product->length ), 'cm' ); 
  362.                     $_weight = wc_get_weight( $this->fix_format( $product->weight ), 'kg' ); 
  363.                 } else { 
  364.                     $_height = woocommerce_get_dimension( $this->fix_format( $product->height ), 'cm' ); 
  365.                     $_width = woocommerce_get_dimension( $this->fix_format( $product->width ), 'cm' ); 
  366.                     $_length = woocommerce_get_dimension( $this->fix_format( $product->length ), 'cm' ); 
  367.                     $_weight = woocommerce_get_weight( $this->fix_format( $product->weight ), 'kg' ); 
  368.                 } 
  369.  
  370.                 $height[ $count ] = $_height; 
  371.                 $width[ $count ]  = $_width; 
  372.                 $length[ $count ] = $_length; 
  373.                 $weight[ $count ] = $_weight; 
  374.  
  375.                 if ( $qty > 1 ) { 
  376.                     $n = $count; 
  377.                     for ( $i = 0; $i < $qty; $i++ ) { 
  378.                         $height[ $n ] = $_height; 
  379.                         $width[ $n ]  = $_width; 
  380.                         $length[ $n ] = $_length; 
  381.                         $weight[ $n ] = $_weight; 
  382.                         $n++; 
  383.                     } 
  384.                     $count = $n; 
  385.                 } 
  386.  
  387.                 $count++; 
  388.             } 
  389.         } 
  390.  
  391.         return array( 
  392.             'height' => array_values( $height ),  
  393.             'length' => array_values( $length ),  
  394.             'width' => array_values( $width ),  
  395.             'weight' => array_sum( $weight ),  
  396.  ); 
  397.     } 
  398.  
  399.     /** 
  400.      * estimating_delivery function. 
  401.      * 
  402.      * @param string $label 
  403.      * @param string $date 
  404.      * 
  405.      * @return string 
  406.      */ 
  407.     protected function estimating_delivery( $label, $date ) { 
  408.         $msg = $label; 
  409.  
  410.         if ( $this->additional_time > 0 ) { 
  411.             $date += (int) $this->additional_time; 
  412.         } 
  413.  
  414.         if ( $date > 0 ) { 
  415.             $msg .= ' (' . sprintf( _n( 'Delivery in %d working day', 'Delivery in %d working days', $date, 'wcjamef' ), $date ) . ')'; 
  416.         } 
  417.  
  418.         return $msg; 
  419.     } 
  420.  
  421.     /** 
  422.      * Connection method. 
  423.      * 
  424.      * @param mixed  $unit_origin     Jamet unit of the origin. 
  425.      * @param mixed  $zip_destination Zip Code of the destination. 
  426.      * @param float  $height          Height total. 
  427.      * @param float  $width           Width total. 
  428.      * @param float  $diameter        Diamenter total. 
  429.      * @param float  $length          Length total. 
  430.      * @param float  $weight          Weight total. 
  431.      * @param string $receipt_notice  Notice. 
  432.      * 
  433.      * @return array                  Quotes. 
  434.      */ 
  435.     protected function jamef_connect( 
  436.         $cnpj,  
  437.         $unit_origin,  
  438.         $state_origin,  
  439.         $zip_destination,  
  440.         $cubage,  
  441.         $weight,  
  442.         $declared = 0,  
  443.         $receipt_notice = 'N' ) { 
  444.  
  445.         $quotes = array(); 
  446.  
  447.         // Sets the get query. 
  448.         $query = http_build_query( array( 
  449.             'P_CIC_NEGC' => $this->fix_zip_code( $cnpj ),  
  450.             'P_CEP' => $this->fix_zip_code( $zip_destination ),  
  451.             'P_COD_REGN' => $unit_origin,  
  452.             'P_PESO_KG' => $this->fix_simplexml_format( $weight ),  
  453.             'P_VLR_CARG' => $declared,  
  454.             'P_UF' => $state_origin,  
  455.             'P_CUBG' => $cubage 
  456.  ), '', '&' ); 
  457.  
  458.         if ( 'yes' == $this->debug ) { 
  459.             $this->log->add( 'jamef', 'Requesting the Jamef WebServices...' ); 
  460.         } 
  461.  
  462.         // Gets the WebServices response. 
  463.         $response = wp_remote_get( $this->webservice . $query, array( 'sslverify' => false, 'timeout' => 30 ) ); 
  464.  
  465.         if ( is_wp_error( $response ) ) { 
  466.             if ( 'yes' == $this->debug ) { 
  467.                 $this->log->add( 'jamef', 'WP_Error: ' . $response->get_error_message() ); 
  468.             } 
  469.         } elseif ( $response['response']['code'] >= 200 && $response['response']['code'] < 300 ) { 
  470.             $result = $response['body']; 
  471.  
  472.             if ( 'yes' == $this->debug ) { 
  473.                 $this->log->add( 'jamef', 'Jamef WebServices response: ' . print_r( substr($result, 13), true ) ); 
  474.             } 
  475.  
  476.             $quotes = substr($result, 13); 
  477.         } else { 
  478.             if ( 'yes' == $this->debug ) { 
  479.                 $this->log->add( 'jamef', 'Error accessing the Jamef WebServices: ' . $response['response']['code'] . ' - ' . $response['response']['message'] ); 
  480.             } 
  481.         } 
  482.  
  483.         return $quotes; 
  484.     } 
  485.  
  486.     /** 
  487.      * Gets the price of shipping. 
  488.      * 
  489.      * @param  array $package Order package. 
  490.      * 
  491.      * @return array          Jamef Quotes. 
  492.      */ 
  493.     protected function jamef_quote( $package ) { 
  494.  
  495.         // Proccess measures. 
  496.         $measures = apply_filters( 'wcjamef_default_package', $this->measures_extract( $package ) ); 
  497.  
  498.         // Checks if the cart is not just virtual goods. 
  499.         if ( ! empty( $measures['height'] ) && ! empty( $measures['width'] ) && ! empty( $measures['length'] ) ) { 
  500.  
  501.             // Get the Cubage. 
  502.             $all = array(); 
  503.             $total = ''; 
  504.  
  505.             for ( $i = 0; $i < count( $this->height ); $i++ ) { 
  506.                 $all[ $i ] = ( $measures['height'][ $i ] * $measures['width'][ $i ] * $measures['length'][ $i ] ) / 1000000; 
  507.             } 
  508.  
  509.             foreach ( $all as $value ) { 
  510.                 $totalcubage += $value; 
  511.             } 
  512.  
  513.             $zip_destination = $package['destination']['postcode']; 
  514.  
  515.             // Test min values. 
  516.             $min_height = $this->minimum_height; 
  517.             $min_width = $this->minimum_width; 
  518.             $min_length = $this->minimum_length; 
  519.  
  520.             $test_cubage = ( $min_height * $min_width * $min_length ) / 1000000; 
  521.             if( $totalcubage < $test_cubage ) 
  522.                 $totalcubage = $test_cubage; 
  523.  
  524.             $cubage = str_replace( '.', ', ', $totalcubage ); 
  525.  
  526.             $declared = 0; 
  527.             $declared = number_format( $this->woocommerce_method()->cart->cart_contents_total, 2, ', ', '' ); 
  528.  
  529.             // Get quotes. 
  530.             $quotes = $this->jamef_connect( 
  531.                 $this->settings['cnpj'],  
  532.                 $this->settings['unit_origin'],  
  533.                 $this->settings['state_origin'],  
  534.                 $zip_destination,  
  535.                 $cubage,  
  536.                 $measures['weight'],  
  537.                 $declared 
  538.  ); 
  539.  
  540.             return $quotes; 
  541.  
  542.         } else { 
  543.  
  544.             // Cart only with virtual products. 
  545.             if ( 'yes' == $this->debug ) { 
  546.                 $this->log->add( 'jamef', 'Cart only with virtual products.' ); 
  547.             } 
  548.  
  549.             return array(); 
  550.         } 
  551.     } 
  552.  
  553.     /** 
  554.      * Calculates the shipping rate. 
  555.      * 
  556.      * @param array $package Order package. 
  557.      * 
  558.      * @return void 
  559.      */ 
  560.     public function calculate_shipping( $package = array() ) { 
  561.         $rates = array(); 
  562.         $quotes = $this->jamef_quote( $package ); 
  563.  
  564.         if ( $quotes > 0 ) { 
  565.  
  566.             $cust = $this->fix_format( esc_attr( $quotes ) ); 
  567.             $fee = $this->get_fee( $this->fix_format( $this->fee ), $cust ); 
  568.  
  569.             array_push( 
  570.                 $rates,  
  571.                 array( 
  572.                     'id' => $this->title,  
  573.                     'label' => $this->title,  
  574.                     'cost' => $cust + $fee,  
  575.  ) 
  576.  ); 
  577.  
  578.             $rate = apply_filters( 'woocommerce_jamef_shipping_methods', $rates, $package ); 
  579.  
  580.             // Register the rate. 
  581.             foreach ( $rate as $key => $value ) 
  582.                 $this->add_rate( $value ); 
  583.         } else { 
  584.             $woocommerce->add_error( 'Desculpe, sua regio ainda no  atendida por nossa transportadora!' ); 
  585.         } 
  586.     } 
  587. }