WC_Shipping_Method - Code Metrics - Inspection of "Shipping zones" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9826)

by Mike

created 2015-12-18 14:24 UTC

WC_Shipping_Method C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	434
Duplicated Lines	10.14 %

Coupling/Cohesion

Components	2
Dependencies	7

Metric	Value
wmc	66
lcom	2
cbo	7
dl	44
loc	434
rs	5.7475

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	supports()	0	3	1
A	calculate_shipping()	0	1	1
A	is_taxable()	0	3	3
A	is_enabled()	0	3	1
A	get_instance_id()	0	3	1
A	get_method_title()	0	3	1
A	get_method_description()	0	3	1
A	get_title()	0	3	1
A	get_rates_for_package()	0	7	4
D	add_rate()	0	25	9
C	get_taxes_per_item()	0	34	11
B	is_available()	9	23	6
A	get_fee()	0	9	4
A	has_settings()	0	3	2
A	admin_options()	0	10	2
A	get_option()	0	9	2
B	get_instance_option()	17	17	5
A	get_instance_form_fields()	0	3	1
A	get_instance_option_key()	0	3	2
A	init_instance_settings()	9	9	2
B	process_admin_options()	9	19	5

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like WC_Shipping_Method often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use WC_Shipping_Method, and based on these observations, apply Extract Interface, too.

<?php


if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * WooCommerce Shipping Method Class.
 *
 * Extended by shipping methods to handle shipping calculations etc.
 *
 * @class       WC_Shipping_Method
 * @version     2.6.0
 * @package     WooCommerce/Abstracts
 * @category    Abstract Class
 * @author      WooThemes
 */
abstract class WC_Shipping_Method extends WC_Settings_API {

	/**
	 * Features this method supports. Possible features used by core:
	 * - shipping-zones Shipping zone functionality + instances
	 * - instance-settings Instance settings screens.
	 * - settings Non-instance settings screens. Enabled by default for BW compatibility with methods before instances existed.
	 * @var array
	 */
	public $supports             = array( 'settings' );

	/**
	 * Unique ID for the shipping method - must be set.
	 * @var string
	 */
	public $id                   = '';

	/**
	 * Method title.
	 * @var string
	 */
	public $method_title         = '';

	/**
	 * Method description.
	 * @var string
	 */
	public $method_description   = '';

	/**
	 * yes or no based on whether the method is enabled.
	 * @var string
	 */
	public $enabled              = 'yes';

	/**
	 * Shipping method title for the frontend.
	 * @var string
	 */
	public $title;

	/**
	 * This is an array of rates - methods must populate this array to register shipping costs.
	 * @var array
	 */
	public $rates                = array();

	/**
	 * If 'taxable' tax will be charged for this method (if applicable).
	 * @var string
	 */
	public $tax_status           = 'taxable';

	/**
	 * Fee for the method (if applicable).
	 * @var string
	 */
	public $fee                  = null;

	/** @var float Minimum fee for the method */
	/**
	 * Minimum fee for the method (if applicable).
	 * @var string
	 */
	public $minimum_fee          = null;

	/**
	 * Instance ID if used.
	 * @var int
	 */
	public $instance_id          = 0;

	/**
	 * Instance form fields.
	 * @var array
	 */
	public $instance_form_fields = array();

	/**
	 * Instance settings.
	 * @var array
	 */
	public $instance_settings    = array();

	/**
	 * Availability - legacy. Used for method Availability.
	 * No longer useful for instance based shipping methods.
	 * @deprecated 2.6.0
	 * @var string
	 */
	public $availability;

	/**
	 * Availability countries - legacy. Used for method Availability.
	 * No longer useful for instance based shipping methods.
	 * @deprecated 2.6.0
	 * @var string
	 */
	public $countries            = array();

	/**
	 * Constructor.
	 * @param int $instance_id
	 */
	public function __construct( $instance_id = 0 ) {
		$this->instance_id = absint( $instance_id );
	}

	/**
	 * Check if a shipping method supports a given feature.
	 *
	 * Methods should override this to declare support (or lack of support) for a feature.
	 *
	 * @param $feature string The name of a feature to test support for.
	 * @return bool True if the shipping method supports the feature, false otherwise.
	 */
	public function supports( $feature ) {
		return apply_filters( 'woocommerce_shipping_method_supports', in_array( $feature, $this->supports ), $feature, $this );
	}

	/**
	 * Called to calculate shipping rates for this method. Rates can be added using the add_rate() method.
	 */
	public function calculate_shipping() {}

	/**
	 * Whether or not we need to calculate tax on top of the shipping rate.
	 * @return boolean
	 */
	public function is_taxable() {
		return wc_tax_enabled() && 'taxable' === $this->tax_status && ! WC()->customer->is_vat_exempt();
	}

	/**
	 * Whether or not this method is enabled in settings.
	 * @since 2.6.0
	 * @return boolean
	 */
	public function is_enabled() {
		return 'yes' === $this->enabled;
	}

	/**
	 * Return the shipping method instance ID.
	 * @since 2.6.0
	 * @return int
	 */
	public function get_instance_id() {
		return $this->instance_id;
	}

	/**
	 * Return the shipping method title.
	 * @since 2.6.0
	 * @return string
	 */
	public function get_method_title() {
		return apply_filters( 'woocommerce_shipping_method_title', $this->method_title, $this );
	}

	/**
	 * Return the shipping method description.
	 * @since 2.6.0
	 * @return string
	 */
	public function get_method_description() {
		return apply_filters( 'woocommerce_shipping_method_description', $this->method_description, $this );
	}

	/**
	 * Return the shipping title which is user set.
	 *
	 * @return string
	 */
	public function get_title() {
		return apply_filters( 'woocommerce_shipping_method_title', $this->title, $this->id );
	}

	/**
	 * Return calculated rates for a package.
	 * @since 2.6.0
	 * @param object $package
	 * @return array
	 */
	public function get_rates_for_package( $package ) {
		$this->rates = array();
		if ( $this->is_available( $package ) && ( empty( $package['ship_via'] ) || in_array( $this->id, $package['ship_via'] ) ) ) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			$this->calculate_shipping( $package );

		}
		return $this->rates;
	}

	/**
	 * Add a shipping rate. If taxes are not set they will be calculated based on cost.
	 * @param array $args (default: array())
	 */
	public function add_rate( $args = array() ) {
		$args = wp_parse_args( $args, array(
			'id'        => '',          // ID for the rate
			'label'     => '',          // Label for the rate
			'cost'      => '0',         // Amount or array of costs (per item shipping)
			'taxes'     => '',          // Pass taxes, nothing to have it calculated for you, or 'false' to calc no tax
			'calc_tax'  => 'per_order'  // Calc tax per_order or per_item. Per item needs an array of costs
		) );

		// ID and label are required
		if ( ! $args['id'] || ! $args['label'] ) {
			return;
		}

		// Handle cost
		$total_cost = is_array( $args['cost'] ) ? array_sum( $args['cost'] ) : $args['cost'];
		$taxes      = $args['taxes'];

		// Taxes - if not an array and not set to false, calc tax based on cost and passed calc_tax variable. This saves shipping methods having to do complex tax calculations.
		if ( ! is_array( $taxes ) && $taxes !== false && $total_cost > 0 && $this->is_taxable() ) {
			$taxes = 'per_item' === $args['calc_tax'] ? $this->get_taxes_per_item( $args['cost'] ) : WC_Tax::calc_shipping_tax( $total_cost, WC_Tax::get_shipping_tax_rates() );
		}

		$this->rates[ $args['id'] ] = new WC_Shipping_Rate( $args['id'], $args['label'], $total_cost, $taxes, $this->id );
	}

	/**
	 * Calc taxes per item being shipping in costs array.
	 * @since 2.6.0
	 * @access protected
	 * @param  array $costs
	 * @return array of taxes
	 */
	protected function get_taxes_per_item( $costs ) {
		$taxes = array();

		// If we have an array of costs we can look up each items tax class and add tax accordingly
		if ( is_array( $costs ) ) {

			$cart = WC()->cart->get_cart();

			foreach ( $costs as $cost_key => $amount ) {
				if ( ! isset( $cart[ $cost_key ] ) ) {
					continue;
				}

				$item_taxes = WC_Tax::calc_shipping_tax( $amount, WC_Tax::get_shipping_tax_rates( $cart[ $cost_key ]['data']->get_tax_class() ) );

				// Sum the item taxes
				foreach ( array_keys( $taxes + $item_taxes ) as $key ) {
					$taxes[ $key ] = ( isset( $item_taxes[ $key ] ) ? $item_taxes[ $key ] : 0 ) + ( isset( $taxes[ $key ] ) ? $taxes[ $key ] : 0 );
				}
			}

			// Add any cost for the order - order costs are in the key 'order'
			if ( isset( $costs['order'] ) ) {
				$item_taxes = WC_Tax::calc_shipping_tax( $costs['order'], WC_Tax::get_shipping_tax_rates() );

				// Sum the item taxes
				foreach ( array_keys( $taxes + $item_taxes ) as $key ) {
					$taxes[ $key ] = ( isset( $item_taxes[ $key ] ) ? $item_taxes[ $key ] : 0 ) + ( isset( $taxes[ $key ] ) ? $taxes[ $key ] : 0 );
				}
			}
		}

		return $taxes;
	}

	/**
	 * Is this method available?
	 * @param array $package
	 * @return bool
	 */
	public function is_available( $package ) {
		$available = $this->is_enabled();

		// Country availability (legacy, for non-zone based methods)
		if ( ! $this->instance_id ) {
			$countries = is_array( $this->countries ) ? $this->countries : array();


			switch ( $this->availability ) {

				case 'specific' :
				case 'including' :

					$available = in_array( $package['destination']['country'], array_intersect( $countries, array_keys( WC()->countries->get_shipping_countries() ) ) );
				break;
				case 'excluding' :

					$available = in_array( $package['destination']['country'], array_diff( array_keys( WC()->countries->get_shipping_countries() ), $countries ) );
				break;
				default :

					$available = in_array( $package['destination']['country'], array_keys( WC()->countries->get_shipping_countries() ) );
				break;
			}
		}

		return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', $available, $package );
	}

	/**
	 * Get fee to add to shipping cost.
	 * @param string|float $fee
	 * @param float $total
	 * @return float
	 */
	public function get_fee( $fee, $total ) {
		if ( strstr( $fee, '%' ) ) {
			$fee = ( $total / 100 ) * str_replace( '%', '', $fee );
		}
		if ( ! empty( $this->minimum_fee ) && $this->minimum_fee > $fee ) {
			$fee = $this->minimum_fee;
		}
		return $fee;
	}

	/**
	 * Does this method have a settings page?
	 * @return bool
	 */
	public function has_settings() {
		return $this->instance_id ? $this->supports( 'instance-settings' ) : $this->supports( 'settings' );
	}

	/**
	 * Output the shipping settings screen.
	 */
	public function admin_options() {
		if ( $this->instance_id ) {
			echo wp_kses_post( wpautop( $this->get_method_description() ) );
			echo '<table class="form-table">' . $this->generate_settings_html( $this->get_instance_form_fields(), false ) . '</table>';
		} else {
			echo '<h2>' . esc_html( $this->get_method_title() ) . '</h2>';
			echo wp_kses_post( wpautop( $this->get_method_description() ) );
			echo '<table class="form-table">' . $this->generate_settings_html( $this->get_form_fields(), false ) . '</table>';
		}
	}

	/**
	 * get_option function.
	 *
	 * Gets and option from the settings API, using defaults if necessary to prevent undefined notices.
	 *
	 * @param  string $key
	 * @param  mixed  $empty_value
	 * @return mixed  The value specified for the option or a default value for the option.
	 */
	public function get_option( $key, $empty_value = null ) {
		// Instance options take priority over global options
		if ( in_array( $key, array_keys( $this->get_instance_form_fields() ) ) ) {
			return $this->get_instance_option( $key, $empty_value );
		}

		// Return global option
		return parent::get_option( $key, $empty_value );
	}

	/**
	 * Gets an option from the settings API, using defaults if necessary to prevent undefined notices.
	 *
	 * @param  string $key
	 * @param  mixed  $empty_value
	 * @return mixed  The value specified for the option or a default value for the option.
	 */
	public function get_instance_option( $key, $empty_value = null ) {

		if ( empty( $this->instance_settings ) ) {
			$this->init_instance_settings();
		}

		// Get option default if unset.
		if ( ! isset( $this->instance_settings[ $key ] ) ) {
			$form_fields                     = $this->get_instance_form_fields();
			$this->instance_settings[ $key ] = $this->get_field_default( $form_fields[ $key ] );
		}

		if ( ! is_null( $empty_value ) && '' === $this->instance_settings[ $key ] ) {
			$this->instance_settings[ $key ] = $empty_value;
		}

		return $this->instance_settings[ $key ];
	}

	/**
	 * Get settings fields for instances of this shipping method (within zones).
	 * Should be overridden by shipping methods to add options.
	 * @since 2.6.0
	 * @return array
	 */
	public function get_instance_form_fields() {
		return apply_filters( 'woocommerce_shipping_instance_form_fields_' . $this->id, $this->instance_form_fields );
	}

	/**
	 * Return the name of the option in the WP DB.
	 * @since 2.6.0
	 * @return string
	 */
	public function get_instance_option_key() {
		return $this->instance_id ? $this->plugin_id . $this->id . $this->instance_id . '_settings' : '';
	}

	/**
	 * Initialise Settings for instances.
	 * @since 2.6.0
	 */
	public function init_instance_settings() {

		$this->instance_settings = get_option( $this->get_instance_option_key(), null );

		// If there are no settings defined, use defaults.
		if ( ! is_array( $this->instance_settings ) ) {
			$form_fields             = $this->get_instance_form_fields();
			$this->instance_settings = array_merge( array_fill_keys( array_keys( $form_fields ), '' ), wp_list_pluck( $form_fields, 'default' ) );
		}
	}

	/**
	 * Processes and saves options.
	 * If there is an error thrown, will continue to save and validate fields, but will leave the erroring field out.
	 * @since 2.6.0
	 * @return bool was anything saved?
	 */
	public function process_admin_options() {
		if ( $this->instance_id ) {
			$this->init_instance_settings();

			foreach ( $this->get_instance_form_fields() as $key => $field ) {

				if ( ! in_array( $this->get_field_type( $field ), array( 'title' ) ) ) {
					try {
						$this->instance_settings[ $key ] = $this->get_field_value( $key, $field );
					} catch ( Exception $e ) {
						$this->add_error( $e->getMessage() );
					}
				}
			}

			return update_option( $this->get_instance_option_key(), apply_filters( 'woocommerce_shipping_' . $this->id . '_instance_settings_values', $this->instance_settings, $this ) );
		} else {
			return parent::process_admin_options();
		}
	}
}


1		<?php
		1 ignored issue – show Coding Style Compatibility introduced 2015-11-21 02:58 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 18 and the first side effect is on line 4. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3		if ( ! defined( 'ABSPATH' ) ) {
4		exit;
5		}
6
7		/**
8		* WooCommerce Shipping Method Class.
9		*
10		* Extended by shipping methods to handle shipping calculations etc.
11		*
12		* @class WC_Shipping_Method
13		* @version 2.6.0
14		* @package WooCommerce/Abstracts
15		* @category Abstract Class
16		* @author WooThemes
17		*/
18		abstract class WC_Shipping_Method extends WC_Settings_API {
19
20		/**
21		* Features this method supports. Possible features used by core:
22		* - shipping-zones Shipping zone functionality + instances
23		* - instance-settings Instance settings screens.
24		* - settings Non-instance settings screens. Enabled by default for BW compatibility with methods before instances existed.
25		* @var array
26		*/
27		public $supports = array( 'settings' );
28
29		/**
30		* Unique ID for the shipping method - must be set.
31		* @var string
32		*/
33		public $id = '';
34
35		/**
36		* Method title.
37		* @var string
38		*/
39		public $method_title = '';
40
41		/**
42		* Method description.
43		* @var string
44		*/
45		public $method_description = '';
46
47		/**
48		* yes or no based on whether the method is enabled.
49		* @var string
50		*/
51		public $enabled = 'yes';
52
53		/**
54		* Shipping method title for the frontend.
55		* @var string
56		*/
57		public $title;
58
59		/**
60		* This is an array of rates - methods must populate this array to register shipping costs.
61		* @var array
62		*/
63		public $rates = array();
64
65		/**
66		* If 'taxable' tax will be charged for this method (if applicable).
67		* @var string
68		*/
69		public $tax_status = 'taxable';
70
71		/**
72		* Fee for the method (if applicable).
73		* @var string
74		*/
75		public $fee = null;
76
77		/** @var float Minimum fee for the method */
78		/**
79		* Minimum fee for the method (if applicable).
80		* @var string
81		*/
82		public $minimum_fee = null;
83
84		/**
85		* Instance ID if used.
86		* @var int
87		*/
88		public $instance_id = 0;
89
90		/**
91		* Instance form fields.
92		* @var array
93		*/
94		public $instance_form_fields = array();
95
96		/**
97		* Instance settings.
98		* @var array
99		*/
100		public $instance_settings = array();
101
102		/**
103		* Availability - legacy. Used for method Availability.
104		* No longer useful for instance based shipping methods.
105		* @deprecated 2.6.0
106		* @var string
107		*/
108		public $availability;
109
110		/**
111		* Availability countries - legacy. Used for method Availability.
112		* No longer useful for instance based shipping methods.
113		* @deprecated 2.6.0
114		* @var string
115		*/
116		public $countries = array();
117
118		/**
119		* Constructor.
120		* @param int $instance_id
121		*/
122		public function __construct( $instance_id = 0 ) {
123		$this->instance_id = absint( $instance_id );
124		}
125
126		/**
127		* Check if a shipping method supports a given feature.
128		*
129		* Methods should override this to declare support (or lack of support) for a feature.
130		*
131		* @param $feature string The name of a feature to test support for.
132		* @return bool True if the shipping method supports the feature, false otherwise.
133		*/
134		public function supports( $feature ) {
135		return apply_filters( 'woocommerce_shipping_method_supports', in_array( $feature, $this->supports ), $feature, $this );
136		}
137
138		/**
139		* Called to calculate shipping rates for this method. Rates can be added using the add_rate() method.
140		*/
141		public function calculate_shipping() {}
142
143		/**
144		* Whether or not we need to calculate tax on top of the shipping rate.
145		* @return boolean
146		*/
147		public function is_taxable() {
148		return wc_tax_enabled() && 'taxable' === $this->tax_status && ! WC()->customer->is_vat_exempt();
149		}
150
151		/**
152		* Whether or not this method is enabled in settings.
153		* @since 2.6.0
154		* @return boolean
155		*/
156		public function is_enabled() {
157		return 'yes' === $this->enabled;
158		}
159
160		/**
161		* Return the shipping method instance ID.
162		* @since 2.6.0
163		* @return int
164		*/
165		public function get_instance_id() {
166		return $this->instance_id;
167		}
168
169		/**
170		* Return the shipping method title.
171		* @since 2.6.0
172		* @return string
173		*/
174		public function get_method_title() {
175		return apply_filters( 'woocommerce_shipping_method_title', $this->method_title, $this );
176		}
177
178		/**
179		* Return the shipping method description.
180		* @since 2.6.0
181		* @return string
182		*/
183		public function get_method_description() {
184		return apply_filters( 'woocommerce_shipping_method_description', $this->method_description, $this );
185		}
186
187		/**
188		* Return the shipping title which is user set.
189		*
190		* @return string
191		*/
192		public function get_title() {
193		return apply_filters( 'woocommerce_shipping_method_title', $this->title, $this->id );
194		}
195
196		/**
197		* Return calculated rates for a package.
198		* @since 2.6.0
199		* @param object $package
200		* @return array
201		*/
202		public function get_rates_for_package( $package ) {
203		$this->rates = array();
204		if ( $this->is_available( $package ) && ( empty( $package['ship_via'] ) \|\| in_array( $this->id, $package['ship_via'] ) ) ) {
		0 ignored issues – show Documentation introduced 2015-12-15 16:38 UTC by Report Bug Copy Issue Report `$package` is of type `object`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
205		$this->calculate_shipping( $package );
		0 ignored issues – show Unused Code introduced 2015-12-15 16:38 UTC by Report Bug Copy Issue Report The call to `WC_Shipping_Method::calculate_shipping()` has too many arguments starting with `$package`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
206		}
207		return $this->rates;
208		}
209
210		/**
211		* Add a shipping rate. If taxes are not set they will be calculated based on cost.
212		* @param array $args (default: array())
213		*/
214		public function add_rate( $args = array() ) {
215		$args = wp_parse_args( $args, array(
216		'id' => '', // ID for the rate
217		'label' => '', // Label for the rate
218		'cost' => '0', // Amount or array of costs (per item shipping)
219		'taxes' => '', // Pass taxes, nothing to have it calculated for you, or 'false' to calc no tax
220		'calc_tax' => 'per_order' // Calc tax per_order or per_item. Per item needs an array of costs
221		) );
222
223		// ID and label are required
224		if ( ! $args['id'] \|\| ! $args['label'] ) {
225		return;
226		}
227
228		// Handle cost
229		$total_cost = is_array( $args['cost'] ) ? array_sum( $args['cost'] ) : $args['cost'];
230		$taxes = $args['taxes'];
231
232		// Taxes - if not an array and not set to false, calc tax based on cost and passed calc_tax variable. This saves shipping methods having to do complex tax calculations.
233		if ( ! is_array( $taxes ) && $taxes !== false && $total_cost > 0 && $this->is_taxable() ) {
234		$taxes = 'per_item' === $args['calc_tax'] ? $this->get_taxes_per_item( $args['cost'] ) : WC_Tax::calc_shipping_tax( $total_cost, WC_Tax::get_shipping_tax_rates() );
235		}
236
237		$this->rates[ $args['id'] ] = new WC_Shipping_Rate( $args['id'], $args['label'], $total_cost, $taxes, $this->id );
238		}
239
240		/**
241		* Calc taxes per item being shipping in costs array.
242		* @since 2.6.0
243		* @access protected
244		* @param array $costs
245		* @return array of taxes
246		*/
247		protected function get_taxes_per_item( $costs ) {
248		$taxes = array();
249
250		// If we have an array of costs we can look up each items tax class and add tax accordingly
251		if ( is_array( $costs ) ) {
252
253		$cart = WC()->cart->get_cart();
254
255		foreach ( $costs as $cost_key => $amount ) {
256		if ( ! isset( $cart[ $cost_key ] ) ) {
257		continue;
258		}
259
260		$item_taxes = WC_Tax::calc_shipping_tax( $amount, WC_Tax::get_shipping_tax_rates( $cart[ $cost_key ]['data']->get_tax_class() ) );
261
262		// Sum the item taxes
263		foreach ( array_keys( $taxes + $item_taxes ) as $key ) {
264		$taxes[ $key ] = ( isset( $item_taxes[ $key ] ) ? $item_taxes[ $key ] : 0 ) + ( isset( $taxes[ $key ] ) ? $taxes[ $key ] : 0 );
265		}
266		}
267
268		// Add any cost for the order - order costs are in the key 'order'
269		if ( isset( $costs['order'] ) ) {
270		$item_taxes = WC_Tax::calc_shipping_tax( $costs['order'], WC_Tax::get_shipping_tax_rates() );
271
272		// Sum the item taxes
273		foreach ( array_keys( $taxes + $item_taxes ) as $key ) {
274		$taxes[ $key ] = ( isset( $item_taxes[ $key ] ) ? $item_taxes[ $key ] : 0 ) + ( isset( $taxes[ $key ] ) ? $taxes[ $key ] : 0 );
275		}
276		}
277		}
278
279		return $taxes;
280		}
281
282		/**
283		* Is this method available?
284		* @param array $package
285		* @return bool
286		*/
287		public function is_available( $package ) {
288		$available = $this->is_enabled();
289
290		// Country availability (legacy, for non-zone based methods)
291		if ( ! $this->instance_id ) {
292		$countries = is_array( $this->countries ) ? $this->countries : array();
		1 ignored issue – show Deprecated Code introduced 2015-12-14 17:08 UTC by Report Bug Copy Issue Report The property `WC_Shipping_Method::$countries` has been deprecated with message: 2.6.0 This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
293
294		switch ( $this->availability ) {
		1 ignored issue – show Deprecated Code introduced 2015-12-14 17:08 UTC by Report Bug Copy Issue Report The property `WC_Shipping_Method::$availability` has been deprecated with message: 2.6.0 This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
295		case 'specific' :
296	View Code Duplication	case 'including' :
		0 ignored issues – show Duplication introduced 2015-12-18 13:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
297		$available = in_array( $package['destination']['country'], array_intersect( $countries, array_keys( WC()->countries->get_shipping_countries() ) ) );
298		break;
299	View Code Duplication	case 'excluding' :
		0 ignored issues – show Duplication introduced 2015-12-18 13:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
300		$available = in_array( $package['destination']['country'], array_diff( array_keys( WC()->countries->get_shipping_countries() ), $countries ) );
301		break;
302	View Code Duplication	default :
		0 ignored issues – show Duplication introduced 2015-12-18 13:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
303		$available = in_array( $package['destination']['country'], array_keys( WC()->countries->get_shipping_countries() ) );
304		break;
305		}
306		}
307
308		return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', $available, $package );
309		}
310
311		/**
312		* Get fee to add to shipping cost.
313		* @param string\|float $fee
314		* @param float $total
315		* @return float
316		*/
317		public function get_fee( $fee, $total ) {
318		if ( strstr( $fee, '%' ) ) {
319		$fee = ( $total / 100 ) * str_replace( '%', '', $fee );
320		}
321		if ( ! empty( $this->minimum_fee ) && $this->minimum_fee > $fee ) {
322		$fee = $this->minimum_fee;
323		}
324		return $fee;
325		}
326
327		/**
328		* Does this method have a settings page?
329		* @return bool
330		*/
331		public function has_settings() {
332		return $this->instance_id ? $this->supports( 'instance-settings' ) : $this->supports( 'settings' );
333		}
334
335		/**
336		* Output the shipping settings screen.
337		*/
338		public function admin_options() {
339		if ( $this->instance_id ) {
340		echo wp_kses_post( wpautop( $this->get_method_description() ) );
341		echo '<table class="form-table">' . $this->generate_settings_html( $this->get_instance_form_fields(), false ) . '</table>';
342		} else {
343		echo '<h2>' . esc_html( $this->get_method_title() ) . '</h2>';
344		echo wp_kses_post( wpautop( $this->get_method_description() ) );
345		echo '<table class="form-table">' . $this->generate_settings_html( $this->get_form_fields(), false ) . '</table>';
346		}
347		}
348
349		/**
350		* get_option function.
351		*
352		* Gets and option from the settings API, using defaults if necessary to prevent undefined notices.
353		*
354		* @param string $key
355		* @param mixed $empty_value
356		* @return mixed The value specified for the option or a default value for the option.
357		*/
358		public function get_option( $key, $empty_value = null ) {
359		// Instance options take priority over global options
360		if ( in_array( $key, array_keys( $this->get_instance_form_fields() ) ) ) {
361		return $this->get_instance_option( $key, $empty_value );
362		}
363
364		// Return global option
365		return parent::get_option( $key, $empty_value );
366		}
367
368		/**
369		* Gets an option from the settings API, using defaults if necessary to prevent undefined notices.
370		*
371		* @param string $key
372		* @param mixed $empty_value
373		* @return mixed The value specified for the option or a default value for the option.
374		*/
375	View Code Duplication	public function get_instance_option( $key, $empty_value = null ) {
		0 ignored issues – show Duplication introduced 2015-12-14 17:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
376		if ( empty( $this->instance_settings ) ) {
377		$this->init_instance_settings();
378		}
379
380		// Get option default if unset.
381		if ( ! isset( $this->instance_settings[ $key ] ) ) {
382		$form_fields = $this->get_instance_form_fields();
383		$this->instance_settings[ $key ] = $this->get_field_default( $form_fields[ $key ] );
384		}
385
386		if ( ! is_null( $empty_value ) && '' === $this->instance_settings[ $key ] ) {
387		$this->instance_settings[ $key ] = $empty_value;
388		}
389
390		return $this->instance_settings[ $key ];
391		}
392
393		/**
394		* Get settings fields for instances of this shipping method (within zones).
395		* Should be overridden by shipping methods to add options.
396		* @since 2.6.0
397		* @return array
398		*/
399		public function get_instance_form_fields() {
400		return apply_filters( 'woocommerce_shipping_instance_form_fields_' . $this->id, $this->instance_form_fields );
401		}
402
403		/**
404		* Return the name of the option in the WP DB.
405		* @since 2.6.0
406		* @return string
407		*/
408		public function get_instance_option_key() {
409		return $this->instance_id ? $this->plugin_id . $this->id . $this->instance_id . '_settings' : '';
410		}
411
412		/**
413		* Initialise Settings for instances.
414		* @since 2.6.0
415		*/
416	View Code Duplication	public function init_instance_settings() {
		0 ignored issues – show Duplication introduced 2015-12-14 17:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
417		$this->instance_settings = get_option( $this->get_instance_option_key(), null );
418
419		// If there are no settings defined, use defaults.
420		if ( ! is_array( $this->instance_settings ) ) {
421		$form_fields = $this->get_instance_form_fields();
422		$this->instance_settings = array_merge( array_fill_keys( array_keys( $form_fields ), '' ), wp_list_pluck( $form_fields, 'default' ) );
423		}
424		}
425
426		/**
427		* Processes and saves options.
428		* If there is an error thrown, will continue to save and validate fields, but will leave the erroring field out.
429		* @since 2.6.0
430		* @return bool was anything saved?
431		*/
432		public function process_admin_options() {
433		if ( $this->instance_id ) {
434		$this->init_instance_settings();
435
436	View Code Duplication	foreach ( $this->get_instance_form_fields() as $key => $field ) {
		0 ignored issues – show Duplication introduced 2015-12-14 17:08 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
437		if ( ! in_array( $this->get_field_type( $field ), array( 'title' ) ) ) {
438		try {
439		$this->instance_settings[ $key ] = $this->get_field_value( $key, $field );
440		} catch ( Exception $e ) {
441		$this->add_error( $e->getMessage() );
442		}
443		}
444		}
445
446		return update_option( $this->get_instance_option_key(), apply_filters( 'woocommerce_shipping_' . $this->id . '_instance_settings_values', $this->instance_settings, $this ) );
447		} else {
448		return parent::process_admin_options();
449		}
450		}
451		}
452

woothemes / woocommerce