File manager - Edit - /home/monara/public_html/test.athavaneng.com/Shipping.tar
Back
ShippingController.php 0000644 00000042363 15073235104 0011112 0 ustar 00 <?php namespace Automattic\WooCommerce\Blocks\Shipping; use Automattic\WooCommerce\Blocks\Assets\Api as AssetApi; use Automattic\WooCommerce\Blocks\Assets\AssetDataRegistry; use Automattic\WooCommerce\Blocks\Utils\CartCheckoutUtils; use Automattic\WooCommerce\StoreApi\Utilities\LocalPickupUtils; use Automattic\WooCommerce\Utilities\ArrayUtil; use WC_Tracks; /** * ShippingController class. * * @internal */ class ShippingController { /** * Instance of the asset API. * * @var AssetApi */ protected $asset_api; /** * Instance of the asset data registry. * * @var AssetDataRegistry */ protected $asset_data_registry; /** * Whether local pickup is enabled. * * @var bool */ private $local_pickup_enabled; /** * Constructor. * * @param AssetApi $asset_api Instance of the asset API. * @param AssetDataRegistry $asset_data_registry Instance of the asset data registry. */ public function __construct( AssetApi $asset_api, AssetDataRegistry $asset_data_registry ) { $this->asset_api = $asset_api; $this->asset_data_registry = $asset_data_registry; $this->local_pickup_enabled = LocalPickupUtils::is_local_pickup_enabled(); } /** * Initialization method. */ public function init() { if ( is_admin() ) { $this->asset_data_registry->add( 'countryStates', function() { return WC()->countries->get_states(); }, true ); } $this->asset_data_registry->add( 'collectableMethodIds', array( 'Automattic\WooCommerce\StoreApi\Utilities\LocalPickupUtils', 'get_local_pickup_method_ids' ), true ); $this->asset_data_registry->add( 'shippingCostRequiresAddress', get_option( 'woocommerce_shipping_cost_requires_address', false ) === 'yes' ); add_action( 'rest_api_init', [ $this, 'register_settings' ] ); add_action( 'admin_enqueue_scripts', [ $this, 'admin_scripts' ] ); add_action( 'admin_enqueue_scripts', [ $this, 'hydrate_client_settings' ] ); add_action( 'woocommerce_load_shipping_methods', array( $this, 'register_local_pickup' ) ); add_filter( 'woocommerce_local_pickup_methods', array( $this, 'register_local_pickup_method' ) ); add_filter( 'woocommerce_order_hide_shipping_address', array( $this, 'hide_shipping_address_for_local_pickup' ), 10 ); add_filter( 'woocommerce_customer_taxable_address', array( $this, 'filter_taxable_address' ) ); add_filter( 'woocommerce_shipping_packages', array( $this, 'filter_shipping_packages' ) ); add_filter( 'pre_update_option_woocommerce_pickup_location_settings', array( $this, 'flush_cache' ) ); add_filter( 'pre_update_option_pickup_location_pickup_locations', array( $this, 'flush_cache' ) ); add_filter( 'woocommerce_shipping_settings', array( $this, 'remove_shipping_settings' ) ); add_filter( 'wc_shipping_enabled', array( $this, 'force_shipping_enabled' ), 100, 1 ); add_filter( 'woocommerce_order_shipping_to_display', array( $this, 'show_local_pickup_details' ), 10, 2 ); add_filter( 'woocommerce_shipping_chosen_method', array( $this, 'prevent_shipping_method_selection_changes' ), 20, 3 ); // This is required to short circuit `show_shipping` from class-wc-cart.php - without it, that function // returns based on the option's value in the DB and we can't override it any other way. add_filter( 'option_woocommerce_shipping_cost_requires_address', array( $this, 'override_cost_requires_address_option' ) ); add_action( 'rest_pre_serve_request', array( $this, 'track_local_pickup' ), 10, 4 ); } /** * Prevent changes in the selected shipping method when new rates are added or removed. * * If the chosen method exists within package rates, it is returned to maintain the selection. * Otherwise, the default rate is returned. * * @param string $default Default shipping method. * @param array $package_rates Associative array of available package rates. * @param string $chosen_method Previously chosen shipping method. * * @return string Chosen shipping method or default. */ public function prevent_shipping_method_selection_changes( $default, $package_rates, $chosen_method ) { // If the chosen method exists in the package rates, return it. if ( $chosen_method && isset( $package_rates[ $chosen_method ] ) ) { return $chosen_method; } // Otherwise, return the default method. return $default; } /** * Overrides the option to force shipping calculations NOT to wait until an address is entered, but only if the * Checkout page contains the Checkout Block. * * @param boolean $value Whether shipping cost calculation requires address to be entered. * @return boolean Whether shipping cost calculation should require an address to be entered before calculating. */ public function override_cost_requires_address_option( $value ) { if ( CartCheckoutUtils::is_checkout_block_default() && $this->local_pickup_enabled ) { return 'no'; } return $value; } /** * Force shipping to be enabled if the Checkout block is in use on the Checkout page. * * @param boolean $enabled Whether shipping is currently enabled. * @return boolean Whether shipping should continue to be enabled/disabled. */ public function force_shipping_enabled( $enabled ) { if ( CartCheckoutUtils::is_checkout_block_default() && $this->local_pickup_enabled ) { return true; } return $enabled; } /** * Inject collection details onto the order received page. * * @param string $return Return value. * @param \WC_Order $order Order object. * @return string */ public function show_local_pickup_details( $return, $order ) { // Confirm order is valid before proceeding further. if ( ! $order instanceof \WC_Order ) { return $return; } $shipping_method_ids = ArrayUtil::select( $order->get_shipping_methods(), 'get_method_id', ArrayUtil::SELECT_BY_OBJECT_METHOD ); $shipping_method_id = current( $shipping_method_ids ); // Ensure order used pickup location method, otherwise bail. if ( 'pickup_location' !== $shipping_method_id ) { return $return; } $shipping_method = current( $order->get_shipping_methods() ); $details = $shipping_method->get_meta( 'pickup_details' ); $location = $shipping_method->get_meta( 'pickup_location' ); $address = $shipping_method->get_meta( 'pickup_address' ); if ( ! $address ) { return $return; } return sprintf( // Translators: %s location name. __( 'Collection from <strong>%s</strong>:', 'woocommerce' ), $location ) . '<br/><address>' . str_replace( ',', ',<br/>', $address ) . '</address><br/>' . $details; } /** * When using the cart and checkout blocks this method is used to adjust core shipping settings via a filter hook. * * @param array $settings The default WC shipping settings. * @return array|mixed The filtered settings. */ public function remove_shipping_settings( $settings ) { if ( CartCheckoutUtils::is_checkout_block_default() && $this->local_pickup_enabled ) { foreach ( $settings as $index => $setting ) { if ( 'woocommerce_shipping_cost_requires_address' === $setting['id'] ) { $settings[ $index ]['desc'] .= ' (' . __( 'Not available when using WooCommerce Blocks Local Pickup', 'woocommerce' ) . ')'; $settings[ $index ]['disabled'] = true; $settings[ $index ]['value'] = 'no'; break; } } } return $settings; } /** * Register Local Pickup settings for rest api. */ public function register_settings() { register_setting( 'options', 'woocommerce_pickup_location_settings', [ 'type' => 'object', 'description' => 'WooCommerce Local Pickup Method Settings', 'default' => [], 'show_in_rest' => [ 'name' => 'pickup_location_settings', 'schema' => [ 'type' => 'object', 'properties' => array( 'enabled' => [ 'description' => __( 'If enabled, this method will appear on the block based checkout.', 'woocommerce' ), 'type' => 'string', 'enum' => [ 'yes', 'no' ], ], 'title' => [ 'description' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ), 'type' => 'string', ], 'tax_status' => [ 'description' => __( 'If a cost is defined, this controls if taxes are applied to that cost.', 'woocommerce' ), 'type' => 'string', 'enum' => [ 'taxable', 'none' ], ], 'cost' => [ 'description' => __( 'Optional cost to charge for local pickup.', 'woocommerce' ), 'type' => 'string', ], ), ], ], ] ); register_setting( 'options', 'pickup_location_pickup_locations', [ 'type' => 'array', 'description' => 'WooCommerce Local Pickup Locations', 'default' => [], 'show_in_rest' => [ 'name' => 'pickup_locations', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => array( 'name' => [ 'type' => 'string', ], 'address' => [ 'type' => 'object', 'properties' => array( 'address_1' => [ 'type' => 'string', ], 'city' => [ 'type' => 'string', ], 'state' => [ 'type' => 'string', ], 'postcode' => [ 'type' => 'string', ], 'country' => [ 'type' => 'string', ], ), ], 'details' => [ 'type' => 'string', ], 'enabled' => [ 'type' => 'boolean', ], ), ], ], ], ] ); } /** * Hydrate client settings */ public function hydrate_client_settings() { $locations = get_option( 'pickup_location_pickup_locations', [] ); $formatted_pickup_locations = []; foreach ( $locations as $location ) { $formatted_pickup_locations[] = [ 'name' => $location['name'], 'address' => $location['address'], 'details' => $location['details'], 'enabled' => wc_string_to_bool( $location['enabled'] ), ]; } $has_legacy_pickup = false; // Get all shipping zones. $shipping_zones = \WC_Shipping_Zones::get_zones( 'admin' ); $international_shipping_zone = new \WC_Shipping_Zone( 0 ); // Loop through each shipping zone. foreach ( $shipping_zones as $shipping_zone ) { // Get all registered rates for this shipping zone. $shipping_methods = $shipping_zone['shipping_methods']; // Loop through each registered rate. foreach ( $shipping_methods as $shipping_method ) { if ( 'local_pickup' === $shipping_method->id && 'yes' === $shipping_method->enabled ) { $has_legacy_pickup = true; break 2; } } } foreach ( $international_shipping_zone->get_shipping_methods( true ) as $shipping_method ) { if ( 'local_pickup' === $shipping_method->id ) { $has_legacy_pickup = true; break; } } $settings = array( 'pickupLocationSettings' => get_option( 'woocommerce_pickup_location_settings', [] ), 'pickupLocations' => $formatted_pickup_locations, 'readonlySettings' => array( 'hasLegacyPickup' => $has_legacy_pickup, 'storeCountry' => WC()->countries->get_base_country(), 'storeState' => WC()->countries->get_base_state(), ), ); wp_add_inline_script( 'wc-shipping-method-pickup-location', sprintf( 'var hydratedScreenSettings = %s;', wp_json_encode( $settings ) ), 'before' ); } /** * Load admin scripts. */ public function admin_scripts() { $this->asset_api->register_script( 'wc-shipping-method-pickup-location', 'assets/client/blocks/wc-shipping-method-pickup-location.js', [], true ); } /** * Registers the Local Pickup shipping method used by the Checkout Block. */ public function register_local_pickup() { if ( CartCheckoutUtils::is_checkout_block_default() ) { wc()->shipping->register_shipping_method( new PickupLocation() ); } } /** * Declares the Pickup Location shipping method as a Local Pickup method for WooCommerce. * * @param array $methods Shipping method ids. * @return array */ public function register_local_pickup_method( $methods ) { $methods[] = 'pickup_location'; return $methods; } /** * Hides the shipping address on the order confirmation page when local pickup is selected. * * @param array $pickup_methods Method ids. * @return array */ public function hide_shipping_address_for_local_pickup( $pickup_methods ) { return array_merge( $pickup_methods, LocalPickupUtils::get_local_pickup_method_ids() ); } /** * Everytime we save or update local pickup settings, we flush the shipping * transient group. * * @param array $settings The setting array we're saving. * @return array $settings The setting array we're saving. */ public function flush_cache( $settings ) { \WC_Cache_Helper::get_transient_version( 'shipping', true ); return $settings; } /** * Filter the location used for taxes based on the chosen pickup location. * * @param array $address Location args. * @return array */ public function filter_taxable_address( $address ) { if ( null === WC()->session ) { return $address; } // We only need to select from the first package, since pickup_location only supports a single package. $chosen_method = current( WC()->session->get( 'chosen_shipping_methods', array() ) ) ?? ''; $chosen_method_id = explode( ':', $chosen_method )[0]; $chosen_method_instance = explode( ':', $chosen_method )[1] ?? 0; // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment if ( $chosen_method_id && true === apply_filters( 'woocommerce_apply_base_tax_for_local_pickup', true ) && in_array( $chosen_method_id, LocalPickupUtils::get_local_pickup_method_ids(), true ) ) { $pickup_locations = get_option( 'pickup_location_pickup_locations', [] ); $pickup_location = $pickup_locations[ $chosen_method_instance ] ?? []; if ( isset( $pickup_location['address'], $pickup_location['address']['country'] ) && ! empty( $pickup_location['address']['country'] ) ) { $address = array( $pickup_locations[ $chosen_method_instance ]['address']['country'], $pickup_locations[ $chosen_method_instance ]['address']['state'], $pickup_locations[ $chosen_method_instance ]['address']['postcode'], $pickup_locations[ $chosen_method_instance ]['address']['city'], ); } } return $address; } /** * Local Pickup requires all packages to support local pickup. This is because the entire order must be picked up * so that all packages get the same tax rates applied during checkout. * * If a shipping package does not support local pickup (e.g. if disabled by an extension), this filters the option * out for all packages. This will in turn disable the "pickup" toggle in Block Checkout. * * @param array $packages Array of shipping packages. * @return array */ public function filter_shipping_packages( $packages ) { // Check all packages for an instance of a collectable shipping method. $valid_packages = array_filter( $packages, function( $package ) { $shipping_method_ids = ArrayUtil::select( $package['rates'] ?? [], 'get_method_id', ArrayUtil::SELECT_BY_OBJECT_METHOD ); return ! empty( array_intersect( LocalPickupUtils::get_local_pickup_method_ids(), $shipping_method_ids ) ); } ); // Remove pickup location from rates arrays. if ( count( $valid_packages ) !== count( $packages ) ) { $packages = array_map( function( $package ) { if ( ! is_array( $package['rates'] ) ) { $package['rates'] = []; return $package; } $package['rates'] = array_filter( $package['rates'], function( $rate ) { return ! in_array( $rate->get_method_id(), LocalPickupUtils::get_local_pickup_method_ids(), true ); } ); return $package; }, $packages ); } return $packages; } /** * Track local pickup settings changes via Store API * * @param bool $served Whether the request has already been served. * @param \WP_REST_Response $result The response object. * @param \WP_REST_Request $request The request object. * @return bool */ public function track_local_pickup( $served, $result, $request ) { if ( '/wp/v2/settings' !== $request->get_route() ) { return $served; } // Param name here comes from the show_in_rest['name'] value when registering the setting. if ( ! $request->get_param( 'pickup_location_settings' ) && ! $request->get_param( 'pickup_locations' ) ) { return $served; } $event_name = 'local_pickup_save_changes'; $settings = $request->get_param( 'pickup_location_settings' ); $locations = $request->get_param( 'pickup_locations' ); $data = array( 'local_pickup_enabled' => 'yes' === $settings['enabled'] ? true : false, 'title' => __( 'Local Pickup', 'woocommerce' ) === $settings['title'], 'price' => '' === $settings['cost'] ? true : false, 'cost' => '' === $settings['cost'] ? 0 : $settings['cost'], 'taxes' => $settings['tax_status'], 'total_pickup_locations' => count( $locations ), 'pickup_locations_enabled' => count( array_filter( $locations, function( $location ) { return $location['enabled']; } ) ), ); WC_Tracks::record_event( $event_name, $data ); return $served; } } PickupLocation.php 0000644 00000010722 15073235104 0010203 0 ustar 00 <?php namespace Automattic\WooCommerce\Blocks\Shipping; use WC_Shipping_Method; /** * Local Pickup Shipping Method. */ class PickupLocation extends WC_Shipping_Method { /** * Pickup locations. * * @var array */ protected $pickup_locations = []; /** * Cost * * @var string */ protected $cost = ''; /** * Constructor. */ public function __construct() { $this->id = 'pickup_location'; $this->method_title = __( 'Local pickup', 'woocommerce' ); $this->method_description = __( 'Allow customers to choose a local pickup location during checkout.', 'woocommerce' ); $this->init(); } /** * Init function. */ public function init() { $this->enabled = $this->get_option( 'enabled' ); $this->title = $this->get_option( 'title' ); $this->tax_status = $this->get_option( 'tax_status' ); $this->cost = $this->get_option( 'cost' ); $this->supports = [ 'settings', 'local-pickup' ]; $this->pickup_locations = get_option( $this->id . '_pickup_locations', [] ); add_filter( 'woocommerce_attribute_label', array( $this, 'translate_meta_data' ), 10, 3 ); } /** * Checks if a given address is complete. * * @param array $address Address. * @return bool */ protected function has_valid_pickup_location( $address ) { // Normalize address. $address_fields = wp_parse_args( (array) $address, array( 'city' => '', 'postcode' => '', 'state' => '', 'country' => '', ) ); // Country is always required. if ( empty( $address_fields['country'] ) ) { return false; } // If all fields are provided, we can skip further checks. if ( ! empty( $address_fields['city'] ) && ! empty( $address_fields['postcode'] ) && ! empty( $address_fields['state'] ) ) { return true; } // Check validity based on requirements for the country. $country_address_fields = wc()->countries->get_address_fields( $address_fields['country'], 'shipping_' ); foreach ( $country_address_fields as $field_name => $field ) { $key = str_replace( 'shipping_', '', $field_name ); if ( isset( $address_fields[ $key ] ) && true === $field['required'] && empty( $address_fields[ $key ] ) ) { return false; } } return true; } /** * Calculate shipping. * * @param array $package Package information. */ public function calculate_shipping( $package = array() ) { if ( $this->pickup_locations ) { foreach ( $this->pickup_locations as $index => $location ) { if ( ! $location['enabled'] ) { continue; } $this->add_rate( array( 'id' => $this->id . ':' . $index, // This is the label shown in shipping rate/method context e.g. London (Local Pickup). 'label' => wp_kses_post( $this->title . ' (' . $location['name'] . ')' ), 'package' => $package, 'cost' => $this->cost, 'meta_data' => array( 'pickup_location' => wp_kses_post( $location['name'] ), 'pickup_address' => $this->has_valid_pickup_location( $location['address'] ) ? wc()->countries->get_formatted_address( $location['address'], ', ' ) : '', 'pickup_details' => wp_kses_post( $location['details'] ), ), ) ); } } } /** * See if the method is available. * * @param array $package Package information. * @return bool */ public function is_available( $package ) { // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment return apply_filters( 'woocommerce_shipping_' . $this->id . '_is_available', 'yes' === $this->enabled, $package, $this ); } /** * Translates meta data for the shipping method. * * @param string $label Meta label. * @param string $name Meta key. * @param mixed $product Product if applicable. * @return string */ public function translate_meta_data( $label, $name, $product ) { if ( $product ) { return $label; } switch ( $name ) { case 'pickup_location': return __( 'Pickup location', 'woocommerce' ); case 'pickup_address': return __( 'Pickup address', 'woocommerce' ); } return $label; } /** * Admin options screen. * * See also WC_Shipping_Method::admin_options(). */ public function admin_options() { global $hide_save_button; $hide_save_button = true; wp_enqueue_script( 'wc-shipping-method-pickup-location' ); echo '<h2>' . esc_html__( 'Local pickup', 'woocommerce' ) . '</h2>'; echo '<div class="wrap"><div id="wc-shipping-method-pickup-location-settings-container"></div></div>'; } }
| ver. 1.4 |
Github
|
.
| PHP 7.4.33 | Generation time: 0 |
proxy
|
phpinfo
|
Settings