class CommerceCheckoutPane in Commerce Core 8.2

Defines the checkout pane plugin annotation object.

Plugin namespace: Plugin\Commerce\CheckoutPane.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\commerce_checkout\Annotation\CommerceCheckoutPane

11 classes are annotated with CommerceCheckoutPane

BillingInformation in modules/checkout/src/Plugin/Commerce/CheckoutPane/BillingInformation.php

Provides the billing information pane.

CheckoutTest in modules/checkout/tests/modules/commerce_checkout_test/src/Plugin/Commerce/CheckoutPane/CheckoutTest.php

Provides a test pane used in test to test the dependency removal.

CompletionMessage in modules/checkout/src/Plugin/Commerce/CheckoutPane/CompletionMessage.php

Provides the completion message pane.

CompletionRegister in modules/checkout/src/Plugin/Commerce/CheckoutPane/CompletionRegister.php

Provides the registration after checkout pane.

ContactInformation in modules/checkout/src/Plugin/Commerce/CheckoutPane/ContactInformation.php

Provides the contact information pane.

... See full list

File

modules/checkout/src/Annotation/CommerceCheckoutPane.php, line 14

Namespace

Drupal\commerce_checkout\Annotation

class CommerceCheckoutPane extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The checkout pane label.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The checkout pane display label.
   *
   * Defaults to the main label.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $display_label;

  /**
   * The ID of the default step for this pane.
   *
   * Optional. If missing, the pane will be disabled by default.
   *
   * @var string
   */
  public $default_step;

  /**
   * The wrapper element to use when rendering the pane's form.
   *
   * E.g: 'container', 'fieldset'. Defaults to 'container'.
   *
   * @var string
   */
  public $wrapper_element;

  /**
   * Constructs a new CommerceCheckoutPane object.
   *
   * @param array $values
   *   The annotation values.
   */
  public function __construct(array $values) {
    if (empty($values['display_label'])) {
      $values['display_label'] = $values['label'];
    }
    parent::__construct($values);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceCheckoutPane::$default_step	public	property	The ID of the default step for this pane.
CommerceCheckoutPane::$display_label	public	property	The checkout pane display label.
CommerceCheckoutPane::$id	public	property	The plugin ID.
CommerceCheckoutPane::$label	public	property	The checkout pane label.
CommerceCheckoutPane::$wrapper_element	public	property	The wrapper element to use when rendering the pane's form.
CommerceCheckoutPane::__construct	public	function	Constructs a new CommerceCheckoutPane object. Overrides Plugin::__construct
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider