Checkout Steps

ShipmentForm uses subforms and each subform is implemented as a plugin that implements CheckoutSubFormInterface and is provided in CheckoutFactory::createShipmentMethodsSubForms(). The main form uses quote transfer as data store. Data for shipment is stored under QuoteTransfer::shipment as a ShipmentTransfer object.

ShipmentTransfer contains:

• shipmentSelection (string) — the name of the form for the selected shipment.
• carrier (ShipmentCarrierTransfer) — includes information on the shipment carrier.
• method (ShipmentMethodTransfer) — contains information about the shipment method that is currently selected.

Data handling happens after a valid form is being submitted during the ShipmentStep; step receives plugins that implement CheckoutStepHandlerPluginInterface and provided in CheckoutFactory::createShipmentPlugins(). When execute() method is called on ShipmentStep then the plugin that is identified by the ShipmentTransfer::shipmentSelection string is selected and method CheckoutStepHandlerPluginInterface::addToQuote() is called to update QuoteTransfer with payment data. From this part, the data handling is left to concrete CheckoutStepHandler.

The approach of implementing shipment and payment handlers and forms are the same PaymentStep.

PaymentForm uses subforms. Each subform is implemented as a plugin that implements CheckoutSubFormPluginInterface and is provided in the CheckoutFactory::createPaymentMethodSubForms(). Main form uses QuoteTransfer as a data store. Data for payment is stored under QuoteTransfer::payment as a PaymentTransfer object.

Main form has radio buttons, where the customer can select from the available payment methods. Choices are built from the subform name. Each provided subform corresponds to a radio input.

When the form is created, it requires the property path to be provided so that it knows how to map its subform to QuoteTransfer. see property_path. Property path is built out of few parts of PaymentTransfer::payment and subform provides getPropertyPath() that returns a string; this string should return the property that exists under PaymentTransfer.

PaymentTransfer includes:

• paymentProvider (string) — payment provider name (Paypal, Payolution etc..).
• paymentMethod (string) — payment method (credit card, invoice).
• paymentSelection (string) — subform name that is currently selected.

Data handling happens after a valid form is submitted during the PaymentStep. The step receives plugins that implement CheckoutStepHandlerPluginInterface and that are provided in the CheckoutFactory::createPaymentPlugins(). When execute() method is called on PaymentStep, the plugin that is identified by PaymentTransfer::paymentSelection string is selected and the CheckoutStepHandlerPluginInterface::addToQuote() is called to update QuoteTransfer with the payment data. From this part, all population or data handling is left to concrete CheckoutStepHandler.

 #
  <?php
  interface StepInterface
  {
	/**
	 * Requirements for this step, return true when satisfied.
	 *
	 * @param QuoteTransfer $quoteTransfer
	 *
	 * @return bool
	 */
	public function preCondition(QuoteTransfer $quoteTransfer);
	/**
	 * Require input, should we render view with form or just skip step after calling execute.
	 *
	 * @return bool
	 */
	public function requireInput();
	/**
	 * Execute step logic, happens after form submit if provided, gets QuoteTransfer filled by data from form.
	 *
	 * @param Request $request
	 * @param QuoteTransfer $quoteTransfer
	 *
	 * @return QuoteTransfer
	 */
	public function execute(Request $request, QuoteTransfer $quoteTransfer);
	/**
	 * Conditions that should be met for this step to be marked as completed. returns true when satisfied.
	 *
	 * @param QuoteTransfer $quoteTransfer
	 *
	 * @return bool
	 */
	public function postCondition(QuoteTransfer $quoteTransfer);
	/**
	 * Current step route.
	 *
	 * @return string
	 */
	public function getStepRoute();
	/**
	 * Escape route when preConditions are not satisfied user will be redirected to provided route.
	 *
	 * @return string
	*/
	public function getEscapeRoute();
 }

 #
	<?php
	interface StepWithExternalRedirectInterface extends StepInterface
	{
		/**
		 * Return external redirect url, when redirect occurs not within same application. Used after execute.
		 *
		 * @return string
		 */
		public function getExternalRedirectUrl();
	}