AgenticCheckoutUtils.php
4 months ago
ArrayUtils.php
2 years ago
CartController.php
1 month ago
CartTokenUtils.php
1 year ago
CheckoutTrait.php
1 month ago
DraftOrderTrait.php
1 year ago
JsonWebToken.php
11 months ago
LocalPickupUtils.php
5 months ago
NoticeHandler.php
1 year ago
OrderAuthorizationTrait.php
6 months ago
OrderController.php
1 month ago
Pagination.php
2 years ago
PaymentUtils.php
1 year ago
ProductItemTrait.php
1 month ago
ProductLinksTrait.php
3 months ago
ProductQuery.php
2 months ago
ProductQueryFilters.php
11 months ago
QuantityLimits.php
11 months ago
RateLimits.php
1 year ago
SanitizationUtils.php
2 years ago
ValidationUtils.php
2 years ago
LocalPickupUtils.php
176 lines
| 1 | <?php |
| 2 | namespace Automattic\WooCommerce\StoreApi\Utilities; |
| 3 | |
| 4 | /** |
| 5 | * Util class for local pickup related functionality, this contains methods that need to be accessed from places besides |
| 6 | * the ShippingController, i.e. the OrderController. |
| 7 | */ |
| 8 | class LocalPickupUtils { |
| 9 | |
| 10 | /** |
| 11 | * Gets the local pickup location settings. |
| 12 | * |
| 13 | * @param string $context The context for the settings. Defaults to 'view'. |
| 14 | */ |
| 15 | public static function get_local_pickup_settings( $context = 'view' ) { |
| 16 | $pickup_location_settings = get_option( |
| 17 | 'woocommerce_pickup_location_settings', |
| 18 | [ |
| 19 | 'enabled' => 'no', |
| 20 | 'title' => __( 'Pickup', 'woocommerce' ), |
| 21 | 'cost' => '', |
| 22 | 'tax_status' => 'taxable', |
| 23 | ] |
| 24 | ); |
| 25 | |
| 26 | if ( empty( $pickup_location_settings['title'] ) ) { |
| 27 | $pickup_location_settings['title'] = __( 'Pickup', 'woocommerce' ); |
| 28 | } |
| 29 | |
| 30 | if ( empty( $pickup_location_settings['enabled'] ) ) { |
| 31 | $pickup_location_settings['enabled'] = 'no'; |
| 32 | } |
| 33 | |
| 34 | if ( ! isset( $pickup_location_settings['cost'] ) ) { |
| 35 | $pickup_location_settings['cost'] = ''; |
| 36 | } |
| 37 | |
| 38 | // Return settings as is if we're editing them. |
| 39 | if ( 'edit' === $context ) { |
| 40 | return $pickup_location_settings; |
| 41 | } |
| 42 | |
| 43 | // All consumers of this turn it into a bool eventually. Doing it here removes the need for that. |
| 44 | $pickup_location_settings['enabled'] = wc_string_to_bool( $pickup_location_settings['enabled'] ); |
| 45 | $pickup_location_settings['title'] = wc_clean( $pickup_location_settings['title'] ); |
| 46 | |
| 47 | return $pickup_location_settings; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Checks if WC Blocks local pickup is enabled. |
| 52 | * |
| 53 | * @return bool True if local pickup is enabled. |
| 54 | */ |
| 55 | public static function is_local_pickup_enabled() { |
| 56 | // Get option directly to avoid early translation function call. |
| 57 | // See https://github.com/woocommerce/woocommerce/pull/47113. |
| 58 | $pickup_location_settings = get_option( |
| 59 | 'woocommerce_pickup_location_settings', |
| 60 | [ |
| 61 | 'enabled' => 'no', |
| 62 | ] |
| 63 | ); |
| 64 | |
| 65 | if ( empty( $pickup_location_settings['enabled'] ) ) { |
| 66 | $pickup_location_settings['enabled'] = 'no'; |
| 67 | } |
| 68 | |
| 69 | return wc_string_to_bool( $pickup_location_settings['enabled'] ); |
| 70 | } |
| 71 | /** |
| 72 | * Gets a list of payment method ids that support the 'local-pickup' feature. |
| 73 | * |
| 74 | * @return string[] List of payment method ids that support the 'local-pickup' feature. |
| 75 | */ |
| 76 | public static function get_local_pickup_method_ids() { |
| 77 | $all_methods_supporting_local_pickup = array_reduce( |
| 78 | WC()->shipping()->get_shipping_methods(), |
| 79 | function ( $methods, $method ) { |
| 80 | if ( $method->supports( 'local-pickup' ) ) { |
| 81 | $methods[] = $method->id; |
| 82 | } |
| 83 | return $methods; |
| 84 | }, |
| 85 | array( 'local_pickup' ) |
| 86 | ); |
| 87 | |
| 88 | // We use array_values because this will be used in JS, so we don't need the (numerical) keys. |
| 89 | return array_values( |
| 90 | // This array_unique is necessary because WC()->shipping()->get_shipping_methods() can return duplicates. |
| 91 | array_unique( |
| 92 | $all_methods_supporting_local_pickup |
| 93 | ) |
| 94 | ); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Checks if a method is a local pickup method. |
| 99 | * |
| 100 | * @param string $method_id The method id to check. |
| 101 | * @return bool True if the method is a local pickup method. |
| 102 | */ |
| 103 | public static function is_local_pickup_method( $method_id ) { |
| 104 | return in_array( $method_id, self::get_local_pickup_method_ids(), true ); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Gets local pickup locations for block editor preview, including placeholder |
| 109 | * locations for custom shipping methods that support local pickup. |
| 110 | * |
| 111 | * This method combines the built-in pickup_location locations with placeholder |
| 112 | * entries for any other shipping methods that declare 'local-pickup' support. |
| 113 | * This allows custom shipping methods to appear in the block editor preview. |
| 114 | * |
| 115 | * @return array Array of pickup locations with the following structure: |
| 116 | * - 'name' (string) The location name. |
| 117 | * - 'enabled' (bool) Whether the location is enabled. |
| 118 | * - 'address' (array) Address array with keys: address_1, city, state, postcode, country. |
| 119 | * - 'details' (string) Additional details about the location. |
| 120 | * - 'method_id' (string) The shipping method ID this location belongs to. |
| 121 | * |
| 122 | * @since 10.5.0 |
| 123 | */ |
| 124 | public static function get_local_pickup_method_locations() { |
| 125 | // Get the built-in pickup locations. |
| 126 | $builtin_locations = get_option( 'pickup_location_pickup_locations', array() ); |
| 127 | |
| 128 | // Add method_id to built-in locations. |
| 129 | foreach ( $builtin_locations as $index => $location ) { |
| 130 | $builtin_locations[ $index ]['method_id'] = 'pickup_location'; |
| 131 | } |
| 132 | |
| 133 | // Get all shipping methods that support local-pickup. |
| 134 | $shipping_methods = WC()->shipping()->get_shipping_methods(); |
| 135 | |
| 136 | // Get store base address for placeholder locations. |
| 137 | $base_country = WC()->countries->get_base_country(); |
| 138 | $base_state = WC()->countries->get_base_state(); |
| 139 | |
| 140 | $custom_method_locations = array(); |
| 141 | |
| 142 | foreach ( $shipping_methods as $method ) { |
| 143 | // Skip if method doesn't support local-pickup. |
| 144 | if ( ! $method->supports( 'local-pickup' ) ) { |
| 145 | continue; |
| 146 | } |
| 147 | |
| 148 | // Skip the built-in pickup_location method (already handled above). |
| 149 | if ( 'pickup_location' === $method->id ) { |
| 150 | continue; |
| 151 | } |
| 152 | |
| 153 | // Create a placeholder location for this custom method. |
| 154 | $custom_method_locations[] = array( |
| 155 | 'name' => $method->get_method_title(), |
| 156 | 'enabled' => true, |
| 157 | 'address' => array( |
| 158 | 'address_1' => '123 Main Street', |
| 159 | 'city' => 'Sample City', |
| 160 | 'state' => $base_state, |
| 161 | 'postcode' => '12345', |
| 162 | 'country' => $base_country, |
| 163 | ), |
| 164 | 'details' => sprintf( |
| 165 | /* translators: %s: shipping method title */ |
| 166 | __( 'Pickup location for %s', 'woocommerce' ), |
| 167 | $method->get_method_title() |
| 168 | ), |
| 169 | 'method_id' => $method->id, |
| 170 | ); |
| 171 | } |
| 172 | |
| 173 | return array_merge( $builtin_locations, $custom_method_locations ); |
| 174 | } |
| 175 | } |
| 176 |