interface CheckoutFlowWithPanesInterface in Commerce Core 8.2

Defines the interface for checkout flows which have panes.

Hierarchy

• interface \Drupal\Core\Form\FormInterface; interface \Drupal\Core\Form\BaseFormIdInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\commerce_checkout\Plugin\Commerce\CheckoutFlow\CheckoutFlowInterface
    • interface \Drupal\commerce_checkout\Plugin\Commerce\CheckoutFlow\CheckoutFlowWithPanesInterface

1 file declares its use of CheckoutFlowWithPanesInterface

CheckoutFlow.php in modules/checkout/src/Entity/CheckoutFlow.php

File

modules/checkout/src/Plugin/Commerce/CheckoutFlow/CheckoutFlowWithPanesInterface.php, line 8

Namespace

Drupal\commerce_checkout\Plugin\Commerce\CheckoutFlow

interface CheckoutFlowWithPanesInterface extends CheckoutFlowInterface {

  /**
   * Gets the panes.
   *
   * @return \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneInterface[]
   *   The panes, keyed by pane id, ordered by weight.
   */
  public function getPanes();

  /**
   * Gets the visible panes for the given step ID.
   *
   * @param string $step_id
   *   The step ID.
   *
   * @return \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneInterface[]
   *   The panes, keyed by pane id, ordered by weight.
   */
  public function getVisiblePanes($step_id);

  /**
   * Gets a pane with the given ID.
   *
   * @param string $pane_id
   *   The pane ID.
   *
   * @return \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneInterface|null
   *   The pane, or NULL if not found.
   */
  public function getPane($pane_id);

}

Members

Name	Modifiers	Type	Description	Overrides
BaseFormIdInterface::getBaseFormId	public	function	Returns a string identifying the base form.	5
CheckoutFlowInterface::getNextStepId	public	function	Gets the next step ID for the given step ID.	1
CheckoutFlowInterface::getOrder	public	function	Gets the current order.	1
CheckoutFlowInterface::getPreviousStepId	public	function	Gets the previous step ID for the given step ID.	1
CheckoutFlowInterface::getSteps	public	function	Gets the defined steps.	1
CheckoutFlowInterface::getVisibleSteps	public	function	Gets the visible steps.	1
CheckoutFlowInterface::redirectToStep	public	function	Redirects an order to a specific step in the checkout.	1
CheckoutFlowWithPanesInterface::getPane	public	function	Gets a pane with the given ID.	1
CheckoutFlowWithPanesInterface::getPanes	public	function	Gets the panes.	1
CheckoutFlowWithPanesInterface::getVisiblePanes	public	function	Gets the visible panes for the given step ID.	1
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
FormInterface::buildForm	public	function	Form constructor.	179
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
FormInterface::submitForm	public	function	Form submission handler.	192
FormInterface::validateForm	public	function	Form validation handler.	30
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2