first commit

wp/wp-content/plugins/woocommerce/packages/woocommerce-blocks/src/Shipping/PickupLocation.php

@@ -0,0 +1,109 @@
+<?php
+namespace Automattic\WooCommerce\Blocks\Shipping;
+
+use WC_Shipping_Method;
+
+/**
+ * Local Pickup Shipping Method.
+ */
+class PickupLocation extends WC_Shipping_Method {
+
+	/**
+	 * 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 );
+	}
+
+	/**
+	 * 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'  => 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>';
+	}
+}