shipping-workshop-extend-store-endpoint.php.mustache

<?php
use Automattic\WooCommerce\Blocks\StoreApi\Schemas\CheckoutSchema;

/**
 * Shipping Workshop Extend Store API.
 */
class Shipping_Workshop_Extend_Store_Endpoint {
	/**
	 * Stores Rest Extending instance.
	 *
	 * @var ExtendRestApi
	 */
	private static $extend;

	/**
	 * Plugin Identifier, unique to each plugin.
	 *
	 * @var string
	 */
	const IDENTIFIER = 'shipping-workshop';

	/**
	 * Bootstraps the class and hooks required data.
	 *
	 */
	public static function init() {
		self::$extend = Automattic\WooCommerce\StoreApi\StoreApi::container()->get( Automattic\WooCommerce\StoreApi\Schemas\ExtendSchema::class );
		self::extend_store();
	}

	/**
	 * Registers the actual data into each endpoint.
	 */
	public static function extend_store() {
		/**
		 * [backend-step-02]
		 * 📝 Once the `extend_checkout_schema` method is complete (see [backend-step-01]) you can
		 * uncomment the code below.
		 */
        /*
		if ( is_callable( [ self::$extend, 'register_endpoint_data' ] ) ) {
			self::$extend->register_endpoint_data(
				[
					'endpoint'        => CheckoutSchema::IDENTIFIER,
					'namespace'       => self::IDENTIFIER,
					'schema_callback' => [ 'Shipping_Workshop_Extend_Store_Endpoint', 'extend_checkout_schema' ],
					'schema_type'     => ARRAY_A,
				]
			);
		}
        */
	}


	/**
	 * Register shipping workshop schema into the Checkout endpoint.
	 *
	 * @return array Registered schema.
	 *
	 */
	public static function extend_checkout_schema() {
        /**
         * [backend-step-01]
		 * 📝 Uncomment the code below and update the values in the array, following the instructions.
         *
         * We need to describe the shape of the data we're adding to the Checkout endpoint. Since we expect the shopper
         * to supply an option from the select box and MAYBE enter text into the `other` field, we need to describe two things.
         *
         * This function should return an array. Since we're adding two keys on the client, this function should
         * return an array with two keys. Each key describes the shape of the data for each field coming from the client.
         *
         */

        /**
        return [
            'otherShippingValue'   => [
                'description' => // Enter a description,
                'type'        => // Define the type, this should be a `string`,
                'context'     => // Define the contexts this should appear in This should be an array containing `view` and `edit`,
                'readonly'    => // Using a boolean value, make this field readonly,
                'optional'    => // Using a boolean value, make this field optional,
                'arg_options' => [
                    'validate_callback' => function( $value ) {
                        // Make this function return true if $value is a string, or false otherwise.
                    },
                ]
            ],
            'alternateShippingInstruction'   => [
            'description' => // Enter a description,
                'type'        => // Define the type, this should be a `string`,
                'context'     => // Define the contexts this should appear in This should be an array containing `view` and `edit`,
                'readonly'    => // Using a boolean value, make this field readonly,
                'arg_options' => [
                    'validate_callback' => function( $value ) {
                        // Make this function return true if $value is a string, or false otherwise.
                    },
                ]
            ],
        ];
        */
    }
}