WC_Shipping_Zone::get_formatted_location() - Code Metrics - Inspection of "Match zones with no countries" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e1ec01...3ab6a2 )

by Mike

created 2016-06-20 12:23 UTC

WC_Shipping_Zone::get_formatted_location() C

↳ Parent: WC_Shipping_Zone

Complexity

Conditions	7
Paths	48

Size

Total Lines	40
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	27
c	1
b	0
f	0
nc	48
nop	1
dl	0
loc	40
rs	6.7272

<?php

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

/**
 * Represents a single shipping zone
 *
 * @class 		WC_Shipping_Zone
 * @version		2.6.0
 * @package		WooCommerce/Classes
 * @category	Class
 * @author 		WooThemes
 */
class WC_Shipping_Zone extends WC_Data {

	/**
	 * Zone Data
	 * @var array
	 */
	protected $_data = array(
		'zone_id'        => 0,
		'zone_name'      => '',
		'zone_order'     => 0,
		'zone_locations' => array()
	);

	/**
	 * True when location data needs to be re-saved
	 * @var bool
	 */
	private $_locations_changed = false;

	/**
	 * Constructor for zones
	 * @param int|object $zone Zone ID to load from the DB (optional) or already queried data.
	 */
	public function __construct( $zone = 0 ) {
		if ( is_numeric( $zone ) && ! empty( $zone ) ) {
			$this->read( $zone );
		} elseif ( is_object( $zone ) ) {
			$this->set_zone_id( $zone->zone_id );
			$this->set_zone_name( $zone->zone_name );
			$this->set_zone_order( $zone->zone_order );
			$this->read_zone_locations( $zone->zone_id );
		} elseif ( 0 === $zone ) {
			$this->set_zone_name( __( 'Rest of the World', 'woocommerce' ) );
			$this->read_zone_locations( 0 );
		} else {
			$this->set_zone_name( __( 'Zone', 'woocommerce' ) );
		}
	}

	/**
	 * Get ID
	 * @return int
	 */
	public function get_id() {
		return $this->get_zone_id();
	}

	/**
	 * Insert zone into the database
	 */
	public function create() {
		global $wpdb;
		$wpdb->insert( $wpdb->prefix . 'woocommerce_shipping_zones', array(
			'zone_name'  => $this->get_zone_name(),
			'zone_order' => $this->get_zone_order(),
		) );
		$this->set_zone_id( $wpdb->insert_id );
	}

	/**
	 * Read zone.
	 * @param int ID to read from DB
	 */
	public function read( $id ) {
		global $wpdb;

		if ( $zone_data = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zones WHERE zone_id = %d LIMIT 1;", $id ) ) ) {
			$this->set_zone_id( $zone_data->zone_id );
			$this->set_zone_name( $zone_data->zone_name );
			$this->set_zone_order( $zone_data->zone_order );
			$this->read_zone_locations( $zone_data->zone_id );
		}
	}

	/**
	 * Update zone in the database
	 */
	public function update() {
		global $wpdb;
		$wpdb->update( $wpdb->prefix . 'woocommerce_shipping_zones', array(
			'zone_name'  => $this->get_zone_name(),
			'zone_order' => $this->get_zone_order(),
		), array( 'zone_id' => $this->get_zone_id() ) );
	}

	/**
	 * Delete a zone.
	 * @since 2.6.0
	 */
	public function delete() {
		if ( $this->get_id() ) {
			global $wpdb;
			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zone_methods', array( 'zone_id' => $this->get_id() ) );
			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zone_locations', array( 'zone_id' => $this->get_id() ) );
			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zones', array( 'zone_id' => $this->get_id() ) );
			WC_Cache_Helper::incr_cache_prefix( 'shipping_zones' );
			$this->set_zone_id( 0 );
		}
	}

	/**
	 * Save zone data to the database.
	 */
	public function save() {
		$name = $this->get_zone_name();

		if ( empty( $name ) ) {
			$this->set_zone_name( $this->generate_zone_name() );
		}

		if ( ! $this->get_zone_id() ) {
			$this->create();
		} else {
			$this->update();
		}

		$this->save_locations();
		WC_Cache_Helper::incr_cache_prefix( 'shipping_zones' );

		// Increments the transient version to invalidate cache.
		WC_Cache_Helper::get_transient_version( 'shipping', true );
	}

	/**
	 * Get zone ID
	 * @return int
	 */
	public function get_zone_id() {
		return absint( $this->_data['zone_id'] );
	}

	/**
	 * Get zone name
	 * @return string
	 */
	public function get_zone_name() {
		return $this->_data['zone_name'];
	}

	/**
	 * Get zone order
	 * @return int
	 */
	public function get_zone_order() {
		return absint( $this->_data['zone_order'] );
	}

	/**
	 * Get zone locations
	 * @return array of zone objects
	 */
	public function get_zone_locations() {
		return $this->_data['zone_locations'];
	}

	/**
	 * Generate a zone name based on location.
	 * @return string
	 */
	protected function generate_zone_name() {
		$zone_name = $this->get_formatted_location();

		if ( empty( $zone_name ) ) {
			$zone_name = __( 'Zone', 'woocommerce' );
		}

		return $zone_name;
	}

	/**
	 * Return a text string representing what this zone is for.
	 * @return string
	 */
	public function get_formatted_location( $max = 10 ) {
		$location_parts = array();
		$all_continents = WC()->countries->get_continents();
		$all_countries  = WC()->countries->get_countries();
		$all_states     = WC()->countries->get_states();
		$locations      = $this->get_zone_locations();
		$continents     = array_filter( $locations, array( $this, 'location_is_continent' ) );
		$countries      = array_filter( $locations, array( $this, 'location_is_country' ) );
		$states         = array_filter( $locations, array( $this, 'location_is_state' ) );
		$postcodes      = array_filter( $locations, array( $this, 'location_is_postcode' ) );

		foreach ( $continents as $location ) {
			$location_parts[] = $all_continents[ $location->code ]['name'];
		}

		foreach ( $countries as $location ) {
			$location_parts[] = $all_countries[ $location->code ];
		}

		foreach ( $states as $location ) {
			$location_codes = explode( ':', $location->code );
			$location_parts[] = $all_states[ $location_codes[ 0 ] ][ $location_codes[ 1 ] ];
		}

		foreach ( $postcodes as $location ) {
			$location_parts[] = $location->code;
		}

		// Fix display of encoded characters.
		$location_parts = array_map( 'html_entity_decode', $location_parts );

		if ( sizeof( $location_parts ) > $max ) {
			$remaining = sizeof( $location_parts ) - $max;
			return sprintf( _n( '%s and %d other region', '%s and %d other regions', $remaining, 'woocommerce' ), implode( ', ', array_splice( $location_parts, 0, $max ) ), $remaining );
		} elseif ( ! empty( $location_parts ) ) {
			return implode( ', ', $location_parts );
		} else {
			return __( 'Everywhere', 'woocommerce' );
		}
	}

	/**
	 * Get shipping methods linked to this zone
	 * @param bool Only return enabled methods.
	 * @return array of objects
	 */
	public function get_shipping_methods( $enabled_only = false ) {
		global $wpdb;

		$raw_methods_sql = $enabled_only ? "SELECT method_id, method_order, instance_id, is_enabled FROM {$wpdb->prefix}woocommerce_shipping_zone_methods WHERE zone_id = %d AND is_enabled = 1 order by method_order ASC;" : "SELECT method_id, method_order, instance_id, is_enabled FROM {$wpdb->prefix}woocommerce_shipping_zone_methods WHERE zone_id = %d order by method_order ASC;";
		$raw_methods     = $wpdb->get_results( $wpdb->prepare( $raw_methods_sql, $this->get_zone_id() ) );
		$wc_shipping     = WC_Shipping::instance();
		$allowed_classes = $wc_shipping->get_shipping_method_class_names();
		$methods         = array();

		foreach ( $raw_methods as $raw_method ) {
			if ( in_array( $raw_method->method_id, array_keys( $allowed_classes ) ) ) {
				$class_name = $allowed_classes[ $raw_method->method_id ];

				// The returned array may contain instances of shipping methods, as well
				// as classes. If the "class" is an instance, just use it. If not,
				// create an instance.
				if ( is_object( $class_name ) ) {
					$class_name_of_instance = get_class( $class_name );
					$methods[ $raw_method->instance_id ] = new $class_name_of_instance( $raw_method->instance_id );
				} else {
					// If the class is not an object, it should be a string. It's better
					// to double check, to be sure (a class must be a string, anything)
					// else would be useless
					if ( is_string( $class_name ) && class_exists( $class_name ) ) {
						$methods[ $raw_method->instance_id ] = new $class_name( $raw_method->instance_id );
					}
				}

				// Let's make sure that we have an instance before setting its attributes
				if ( is_object( $methods[ $raw_method->instance_id ] ) ) {
					$methods[ $raw_method->instance_id ]->method_order  = absint( $raw_method->method_order );
					$methods[ $raw_method->instance_id ]->enabled       = $raw_method->is_enabled ? 'yes' : 'no';
					$methods[ $raw_method->instance_id ]->has_settings  = $methods[ $raw_method->instance_id ]->has_settings();
					$methods[ $raw_method->instance_id ]->settings_html = $methods[ $raw_method->instance_id ]->supports( 'instance-settings-modal' ) ? $methods[ $raw_method->instance_id ]->get_admin_options_html() : false;
				}
			}
		}

		return apply_filters( 'woocommerce_shipping_zone_shipping_methods', $methods, $raw_methods, $allowed_classes, $this );
	}

	/**
	 * Location type detection
	 * @param  object  $location
	 * @return boolean
	 */
	private function location_is_continent( $location ) {
		return 'continent' === $location->type;
	}

	/**
	 * Location type detection
	 * @param  object  $location
	 * @return boolean
	 */
	private function location_is_country( $location ) {
		return 'country' === $location->type;
	}

	/**
	 * Location type detection
	 * @param  object  $location
	 * @return boolean
	 */
	private function location_is_state( $location ) {
		return 'state' === $location->type;
	}

	/**
	 * Location type detection
	 * @param  object  $location
	 * @return boolean
	 */
	private function location_is_postcode( $location ) {
		return 'postcode' === $location->type;
	}

	/**
	 * Set zone ID
	 * @access private
	 * @param int $set
	 */
	private function set_zone_id( $set ) {
		$this->_data['zone_id'] = absint( $set );
	}

	/**
	 * Set zone name
	 * @param string $set
	 */
	public function set_zone_name( $set ) {
		$this->_data['zone_name'] = wc_clean( $set );
	}

	/**
	 * Set zone order
	 * @param int $set
	 */
	public function set_zone_order( $set ) {
		$this->_data['zone_order'] = absint( $set );
	}

	/**
	 * Is passed location type valid?
	 * @param  string  $type
	 * @return boolean
	 */
	public function is_valid_location_type( $type ) {
		return in_array( $type, array( 'postcode', 'state', 'country', 'continent' ) );
	}

	/**
	 * Add location (state or postcode) to a zone.
	 * @param string $code
	 * @param string $type state or postcode
	 */
	public function add_location( $code, $type ) {
		if ( $this->is_valid_location_type( $type ) ) {
			if ( 'postcode' === $type ) {
				$code = trim( strtoupper( $code ) ); // No normalization - postcodes are matched against both normal and formatted versions to support wildcards.
			}
			$location = array(
				'code' => wc_clean( $code ),
				'type' => wc_clean( $type )
			);
			$this->_data['zone_locations'][] = (object) $location;
			$this->_locations_changed = true;
		}
	}

	/**
	 * Clear all locations for this zone.
	 * @param array|string $types of location to clear
	 */
	public function clear_locations( $types = array( 'postcode', 'state', 'country', 'continent' ) ) {
		if ( ! is_array( $types ) ) {
			$types = array( $types );
		}
		foreach ( $this->_data['zone_locations'] as $key => $values ) {
			if ( in_array( $values->type, $types ) ) {
				unset( $this->_data['zone_locations'][ $key ] );
				$this->_locations_changed = true;
			}
		}
	}

	/**
	 * Set locations
	 * @param array $locations Array of locations
	 */
	public function set_locations( $locations = array() ) {
		$this->clear_locations();

		foreach ( $locations as $location ) {
			$this->add_location( $location['code'], $location['type'] );
		}

		$this->_locations_changed = true;
	}

	/**
	 * Read location data from the database
	 * @param  int $zone_id
	 */
	private function read_zone_locations( $zone_id ) {
		global $wpdb;

		if ( $locations = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zone_locations WHERE zone_id = %d;", $zone_id ) ) ) {
			foreach ( $locations as $location ) {
				$this->add_location( $location->location_code, $location->location_type );
			}
		}
		$this->_locations_changed = false;
	}

	/**
	 * Save locations to the DB.
	 *
	 * This function clears old locations, then re-inserts new if any changes are found.
	 */
	private function save_locations() {
		if ( ! $this->get_zone_id() || ! $this->_locations_changed ) {
			return false;
		}
		global $wpdb;
		$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zone_locations', array( 'zone_id' => $this->get_zone_id() ) );

		foreach ( $this->get_zone_locations() as $location ) {
			$wpdb->insert( $wpdb->prefix . 'woocommerce_shipping_zone_locations', array(
				'zone_id'       => $this->get_zone_id(),
				'location_code' => $location->code,
				'location_type' => $location->type
			) );
		}
	}

	/**
	 * Add a shipping method to this zone.
	 * @param string $type shipping method type
	 * @return int new instance_id, 0 on failure
	 */
	public function add_shipping_method( $type ) {
		global $wpdb;

		$instance_id     = 0;
		$wc_shipping     = WC_Shipping::instance();
		$allowed_classes = $wc_shipping->get_shipping_method_class_names();
		$count           = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_shipping_zone_methods WHERE zone_id = %d", $this->get_zone_id() ) );

		if ( in_array( $type, array_keys( $allowed_classes ) ) ) {
			$wpdb->insert(
				$wpdb->prefix . 'woocommerce_shipping_zone_methods',
				array(
					'method_id'    => $type,
					'zone_id'      => $this->get_zone_id(),
					'method_order' => ( $count + 1 )
				),
				array(
					'%s',
					'%d',
					'%d'
				)
			);
			$instance_id = $wpdb->insert_id;
		}

		if ( $instance_id ) {
			do_action( 'woocommerce_shipping_zone_method_added', $instance_id, $type, $this->get_zone_id() );
		}

		WC_Cache_Helper::get_transient_version( 'shipping', true );

		return $instance_id;
	}
}


1			<?php
2
3			if ( ! defined( 'ABSPATH' ) ) {
4			exit;
5			}
6
7			/**
8			* Represents a single shipping zone
9			*
10			* @class WC_Shipping_Zone
11			* @version 2.6.0
12			* @package WooCommerce/Classes
13			* @category Class
14			* @author WooThemes
15			*/
16			class WC_Shipping_Zone extends WC_Data {
17
18			/**
19			* Zone Data
20			* @var array
21			*/
22			protected $_data = array(
23			'zone_id' => 0,
24			'zone_name' => '',
25			'zone_order' => 0,
26			'zone_locations' => array()
27			);
28
29			/**
30			* True when location data needs to be re-saved
31			* @var bool
32			*/
33			private $_locations_changed = false;
34
35			/**
36			* Constructor for zones
37			* @param int\|object $zone Zone ID to load from the DB (optional) or already queried data.
38			*/
39			public function __construct( $zone = 0 ) {
40			if ( is_numeric( $zone ) && ! empty( $zone ) ) {
41			$this->read( $zone );
42			} elseif ( is_object( $zone ) ) {
43			$this->set_zone_id( $zone->zone_id );
44			$this->set_zone_name( $zone->zone_name );
45			$this->set_zone_order( $zone->zone_order );
46			$this->read_zone_locations( $zone->zone_id );
47			} elseif ( 0 === $zone ) {
48			$this->set_zone_name( __( 'Rest of the World', 'woocommerce' ) );
49			$this->read_zone_locations( 0 );
50			} else {
51			$this->set_zone_name( __( 'Zone', 'woocommerce' ) );
52			}
53			}
54
55			/**
56			* Get ID
57			* @return int
58			*/
59			public function get_id() {
60			return $this->get_zone_id();
61			}
62
63			/**
64			* Insert zone into the database
65			*/
66			public function create() {
67			global $wpdb;
68			$wpdb->insert( $wpdb->prefix . 'woocommerce_shipping_zones', array(
69			'zone_name' => $this->get_zone_name(),
70			'zone_order' => $this->get_zone_order(),
71			) );
72			$this->set_zone_id( $wpdb->insert_id );
73			}
74
75			/**
76			* Read zone.
77			* @param int ID to read from DB
78			*/
79			public function read( $id ) {
80			global $wpdb;
81
82			if ( $zone_data = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zones WHERE zone_id = %d LIMIT 1;", $id ) ) ) {
83			$this->set_zone_id( $zone_data->zone_id );
84			$this->set_zone_name( $zone_data->zone_name );
85			$this->set_zone_order( $zone_data->zone_order );
86			$this->read_zone_locations( $zone_data->zone_id );
87			}
88			}
89
90			/**
91			* Update zone in the database
92			*/
93			public function update() {
94			global $wpdb;
95			$wpdb->update( $wpdb->prefix . 'woocommerce_shipping_zones', array(
96			'zone_name' => $this->get_zone_name(),
97			'zone_order' => $this->get_zone_order(),
98			), array( 'zone_id' => $this->get_zone_id() ) );
99			}
100
101			/**
102			* Delete a zone.
103			* @since 2.6.0
104			*/
105			public function delete() {
106			if ( $this->get_id() ) {
107			global $wpdb;
108			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zone_methods', array( 'zone_id' => $this->get_id() ) );
109			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zone_locations', array( 'zone_id' => $this->get_id() ) );
110			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zones', array( 'zone_id' => $this->get_id() ) );
111			WC_Cache_Helper::incr_cache_prefix( 'shipping_zones' );
112			$this->set_zone_id( 0 );
113			}
114			}
115
116			/**
117			* Save zone data to the database.
118			*/
119			public function save() {
120			$name = $this->get_zone_name();
121
122			if ( empty( $name ) ) {
123			$this->set_zone_name( $this->generate_zone_name() );
124			}
125
126			if ( ! $this->get_zone_id() ) {
127			$this->create();
128			} else {
129			$this->update();
130			}
131
132			$this->save_locations();
133			WC_Cache_Helper::incr_cache_prefix( 'shipping_zones' );
134
135			// Increments the transient version to invalidate cache.
136			WC_Cache_Helper::get_transient_version( 'shipping', true );
137			}
138
139			/**
140			* Get zone ID
141			* @return int
142			*/
143			public function get_zone_id() {
144			return absint( $this->_data['zone_id'] );
145			}
146
147			/**
148			* Get zone name
149			* @return string
150			*/
151			public function get_zone_name() {
152			return $this->_data['zone_name'];
153			}
154
155			/**
156			* Get zone order
157			* @return int
158			*/
159			public function get_zone_order() {
160			return absint( $this->_data['zone_order'] );
161			}
162
163			/**
164			* Get zone locations
165			* @return array of zone objects
166			*/
167			public function get_zone_locations() {
168			return $this->_data['zone_locations'];
169			}
170
171			/**
172			* Generate a zone name based on location.
173			* @return string
174			*/
175			protected function generate_zone_name() {
176			$zone_name = $this->get_formatted_location();
177
178			if ( empty( $zone_name ) ) {
179			$zone_name = __( 'Zone', 'woocommerce' );
180			}
181
182			return $zone_name;
183			}
184
185			/**
186			* Return a text string representing what this zone is for.
187			* @return string
188			*/
189			public function get_formatted_location( $max = 10 ) {
190			$location_parts = array();
191			$all_continents = WC()->countries->get_continents();
192			$all_countries = WC()->countries->get_countries();
193			$all_states = WC()->countries->get_states();
194			$locations = $this->get_zone_locations();
195			$continents = array_filter( $locations, array( $this, 'location_is_continent' ) );
196			$countries = array_filter( $locations, array( $this, 'location_is_country' ) );
197			$states = array_filter( $locations, array( $this, 'location_is_state' ) );
198			$postcodes = array_filter( $locations, array( $this, 'location_is_postcode' ) );
199
200			foreach ( $continents as $location ) {
201			$location_parts[] = $all_continents[ $location->code ]['name'];
202			}
203
204			foreach ( $countries as $location ) {
205			$location_parts[] = $all_countries[ $location->code ];
206			}
207
208			foreach ( $states as $location ) {
209			$location_codes = explode( ':', $location->code );
210			$location_parts[] = $all_states[ $location_codes[ 0 ] ][ $location_codes[ 1 ] ];
211			}
212
213			foreach ( $postcodes as $location ) {
214			$location_parts[] = $location->code;
215			}
216
217			// Fix display of encoded characters.
218			$location_parts = array_map( 'html_entity_decode', $location_parts );
219
220			if ( sizeof( $location_parts ) > $max ) {
221			$remaining = sizeof( $location_parts ) - $max;
222			return sprintf( _n( '%s and %d other region', '%s and %d other regions', $remaining, 'woocommerce' ), implode( ', ', array_splice( $location_parts, 0, $max ) ), $remaining );
223			} elseif ( ! empty( $location_parts ) ) {
224			return implode( ', ', $location_parts );
225			} else {
226			return __( 'Everywhere', 'woocommerce' );
227			}
228			}
229
230			/**
231			* Get shipping methods linked to this zone
232			* @param bool Only return enabled methods.
233			* @return array of objects
234			*/
235			public function get_shipping_methods( $enabled_only = false ) {
236			global $wpdb;
237
238			$raw_methods_sql = $enabled_only ? "SELECT method_id, method_order, instance_id, is_enabled FROM {$wpdb->prefix}woocommerce_shipping_zone_methods WHERE zone_id = %d AND is_enabled = 1 order by method_order ASC;" : "SELECT method_id, method_order, instance_id, is_enabled FROM {$wpdb->prefix}woocommerce_shipping_zone_methods WHERE zone_id = %d order by method_order ASC;";
239			$raw_methods = $wpdb->get_results( $wpdb->prepare( $raw_methods_sql, $this->get_zone_id() ) );
240			$wc_shipping = WC_Shipping::instance();
241			$allowed_classes = $wc_shipping->get_shipping_method_class_names();
242			$methods = array();
243
244			foreach ( $raw_methods as $raw_method ) {
245			if ( in_array( $raw_method->method_id, array_keys( $allowed_classes ) ) ) {
246			$class_name = $allowed_classes[ $raw_method->method_id ];
247
248			// The returned array may contain instances of shipping methods, as well
249			// as classes. If the "class" is an instance, just use it. If not,
250			// create an instance.
251			if ( is_object( $class_name ) ) {
252			$class_name_of_instance = get_class( $class_name );
253			$methods[ $raw_method->instance_id ] = new $class_name_of_instance( $raw_method->instance_id );
254			} else {
255			// If the class is not an object, it should be a string. It's better
256			// to double check, to be sure (a class must be a string, anything)
257			// else would be useless
258			if ( is_string( $class_name ) && class_exists( $class_name ) ) {
259			$methods[ $raw_method->instance_id ] = new $class_name( $raw_method->instance_id );
260			}
261			}
262
263			// Let's make sure that we have an instance before setting its attributes
264			if ( is_object( $methods[ $raw_method->instance_id ] ) ) {
265			$methods[ $raw_method->instance_id ]->method_order = absint( $raw_method->method_order );
266			$methods[ $raw_method->instance_id ]->enabled = $raw_method->is_enabled ? 'yes' : 'no';
267			$methods[ $raw_method->instance_id ]->has_settings = $methods[ $raw_method->instance_id ]->has_settings();
268			$methods[ $raw_method->instance_id ]->settings_html = $methods[ $raw_method->instance_id ]->supports( 'instance-settings-modal' ) ? $methods[ $raw_method->instance_id ]->get_admin_options_html() : false;
269			}
270			}
271			}
272
273			return apply_filters( 'woocommerce_shipping_zone_shipping_methods', $methods, $raw_methods, $allowed_classes, $this );
274			}
275
276			/**
277			* Location type detection
278			* @param object $location
279			* @return boolean
280			*/
281			private function location_is_continent( $location ) {
282			return 'continent' === $location->type;
283			}
284
285			/**
286			* Location type detection
287			* @param object $location
288			* @return boolean
289			*/
290			private function location_is_country( $location ) {
291			return 'country' === $location->type;
292			}
293
294			/**
295			* Location type detection
296			* @param object $location
297			* @return boolean
298			*/
299			private function location_is_state( $location ) {
300			return 'state' === $location->type;
301			}
302
303			/**
304			* Location type detection
305			* @param object $location
306			* @return boolean
307			*/
308			private function location_is_postcode( $location ) {
309			return 'postcode' === $location->type;
310			}
311
312			/**
313			* Set zone ID
314			* @access private
315			* @param int $set
316			*/
317			private function set_zone_id( $set ) {
318			$this->_data['zone_id'] = absint( $set );
319			}
320
321			/**
322			* Set zone name
323			* @param string $set
324			*/
325			public function set_zone_name( $set ) {
326			$this->_data['zone_name'] = wc_clean( $set );
327			}
328
329			/**
330			* Set zone order
331			* @param int $set
332			*/
333			public function set_zone_order( $set ) {
334			$this->_data['zone_order'] = absint( $set );
335			}
336
337			/**
338			* Is passed location type valid?
339			* @param string $type
340			* @return boolean
341			*/
342			public function is_valid_location_type( $type ) {
343			return in_array( $type, array( 'postcode', 'state', 'country', 'continent' ) );
344			}
345
346			/**
347			* Add location (state or postcode) to a zone.
348			* @param string $code
349			* @param string $type state or postcode
350			*/
351			public function add_location( $code, $type ) {
352			if ( $this->is_valid_location_type( $type ) ) {
353			if ( 'postcode' === $type ) {
354			$code = trim( strtoupper( $code ) ); // No normalization - postcodes are matched against both normal and formatted versions to support wildcards.
355			}
356			$location = array(
357			'code' => wc_clean( $code ),
358			'type' => wc_clean( $type )
359			);
360			$this->_data['zone_locations'][] = (object) $location;
361			$this->_locations_changed = true;
362			}
363			}
364
365			/**
366			* Clear all locations for this zone.
367			* @param array\|string $types of location to clear
368			*/
369			public function clear_locations( $types = array( 'postcode', 'state', 'country', 'continent' ) ) {
370			if ( ! is_array( $types ) ) {
371			$types = array( $types );
372			}
373			foreach ( $this->_data['zone_locations'] as $key => $values ) {
374			if ( in_array( $values->type, $types ) ) {
375			unset( $this->_data['zone_locations'][ $key ] );
376			$this->_locations_changed = true;
377			}
378			}
379			}
380
381			/**
382			* Set locations
383			* @param array $locations Array of locations
384			*/
385			public function set_locations( $locations = array() ) {
386			$this->clear_locations();
387
388			foreach ( $locations as $location ) {
389			$this->add_location( $location['code'], $location['type'] );
390			}
391
392			$this->_locations_changed = true;
393			}
394
395			/**
396			* Read location data from the database
397			* @param int $zone_id
398			*/
399			private function read_zone_locations( $zone_id ) {
400			global $wpdb;
401
402			if ( $locations = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_shipping_zone_locations WHERE zone_id = %d;", $zone_id ) ) ) {
403			foreach ( $locations as $location ) {
404			$this->add_location( $location->location_code, $location->location_type );
405			}
406			}
407			$this->_locations_changed = false;
408			}
409
410			/**
411			* Save locations to the DB.
412			*
413			* This function clears old locations, then re-inserts new if any changes are found.
414			*/
415			private function save_locations() {
416			if ( ! $this->get_zone_id() \|\| ! $this->_locations_changed ) {
417			return false;
418			}
419			global $wpdb;
420			$wpdb->delete( $wpdb->prefix . 'woocommerce_shipping_zone_locations', array( 'zone_id' => $this->get_zone_id() ) );
421
422			foreach ( $this->get_zone_locations() as $location ) {
423			$wpdb->insert( $wpdb->prefix . 'woocommerce_shipping_zone_locations', array(
424			'zone_id' => $this->get_zone_id(),
425			'location_code' => $location->code,
426			'location_type' => $location->type
427			) );
428			}
429			}
430
431			/**
432			* Add a shipping method to this zone.
433			* @param string $type shipping method type
434			* @return int new instance_id, 0 on failure
435			*/
436			public function add_shipping_method( $type ) {
437			global $wpdb;
438
439			$instance_id = 0;
440			$wc_shipping = WC_Shipping::instance();
441			$allowed_classes = $wc_shipping->get_shipping_method_class_names();
442			$count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_shipping_zone_methods WHERE zone_id = %d", $this->get_zone_id() ) );
443
444			if ( in_array( $type, array_keys( $allowed_classes ) ) ) {
445			$wpdb->insert(
446			$wpdb->prefix . 'woocommerce_shipping_zone_methods',
447			array(
448			'method_id' => $type,
449			'zone_id' => $this->get_zone_id(),
450			'method_order' => ( $count + 1 )
451			),
452			array(
453			'%s',
454			'%d',
455			'%d'
456			)
457			);
458			$instance_id = $wpdb->insert_id;
459			}
460
461			if ( $instance_id ) {
462			do_action( 'woocommerce_shipping_zone_method_added', $instance_id, $type, $this->get_zone_id() );
463			}
464
465			WC_Cache_Helper::get_transient_version( 'shipping', true );
466
467			return $instance_id;
468			}
469			}
470

woothemes / woocommerce

Push — master ( e1ec01...3ab6a2 )

WC_Shipping_Zone::get_formatted_location() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like