class DemoCouponCallout in Commerce Demo 8

Provides the Order summary pane.

Plugin annotation

@CommerceCheckoutPane(
  id = "demo_coupon_callout",
  label = @Translation("Demo Coupon Callout"),
  default_step = "_sidebar",
  wrapper_element = "container",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneBase implements CheckoutPaneInterface, ContainerFactoryPluginInterface
      • class \Drupal\commerce_demo\Plugin\Commerce\CheckoutPane\DemoCouponCallout implements CheckoutPaneInterface

File

src/Plugin/Commerce/CheckoutPane/DemoCouponCallout.php, line 20

Namespace

Drupal\commerce_demo\Plugin\Commerce\CheckoutPane

class DemoCouponCallout extends CheckoutPaneBase implements CheckoutPaneInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'weight' => 50,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) {
    $build = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'well',
        ],
      ],
    ];
    $build['heading'] = [
      '#type' => 'inline_template',
      '#template' => '<h4 class="text-muted"><strong>{{ title }}</strong></h4>',
      '#context' => [
        'title' => $this
          ->t('Try out a coupon in our demo!'),
      ],
    ];
    $build['coupon_codes'] = [
      '#theme' => 'item_list',
      '#items' => [],
      '#attributes' => [
        'class' => [
          'text-muted',
        ],
      ],
    ];

    /** @var \Drupal\commerce_promotion\CouponStorageInterface $coupon_storage */
    $coupon_storage = $this->entityTypeManager
      ->getStorage('commerce_promotion_coupon');
    $coupons = array_filter($coupon_storage
      ->loadMultiple(), function (CouponInterface $coupon) {
      return $coupon
        ->available($this->order) && $coupon
        ->getPromotion()
        ->applies($this->order);
    });
    $build['coupon_codes']['#items'] = array_map(function (CouponInterface $coupon) {
      return $coupon
        ->getCode();
    }, $coupons);
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CheckoutPaneBase::$checkoutFlow	protected	property	The parent checkout flow.
CheckoutPaneBase::$entityTypeManager	protected	property	The entity type manager.
CheckoutPaneBase::$order	protected	property	The current order.
CheckoutPaneBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	6
CheckoutPaneBase::buildConfigurationSummary	public	function	Builds a summary of the pane configuration. Overrides CheckoutPaneInterface::buildConfigurationSummary	5
CheckoutPaneBase::buildPaneSummary	public	function	Builds a summary of the pane values. Overrides CheckoutPaneInterface::buildPaneSummary	3
CheckoutPaneBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
CheckoutPaneBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	7
CheckoutPaneBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
CheckoutPaneBase::getDisplayLabel	public	function	Gets the pane display label. Overrides CheckoutPaneInterface::getDisplayLabel
CheckoutPaneBase::getId	public	function	Gets the pane ID. Overrides CheckoutPaneInterface::getId
CheckoutPaneBase::getLabel	public	function	Gets the pane label. Overrides CheckoutPaneInterface::getLabel
CheckoutPaneBase::getStepId	public	function	Gets the pane step ID. Overrides CheckoutPaneInterface::getStepId
CheckoutPaneBase::getWeight	public	function	Gets the pane weight. Overrides CheckoutPaneInterface::getWeight
CheckoutPaneBase::getWrapperElement	public	function	Gets the pane wrapper element. Overrides CheckoutPaneInterface::getWrapperElement
CheckoutPaneBase::isVisible	public	function	Determines whether the pane is visible. Overrides CheckoutPaneInterface::isVisible	4
CheckoutPaneBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
CheckoutPaneBase::setOrder	public	function	Sets the current order. Overrides CheckoutPaneInterface::setOrder
CheckoutPaneBase::setStepId	public	function	Sets the pane step ID. Overrides CheckoutPaneInterface::setStepId
CheckoutPaneBase::setWeight	public	function	Sets the pane weight. Overrides CheckoutPaneInterface::setWeight
CheckoutPaneBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	6
CheckoutPaneBase::submitPaneForm	public	function	Handles the submission of an pane form. Overrides CheckoutPaneInterface::submitPaneForm	7
CheckoutPaneBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
CheckoutPaneBase::validatePaneForm	public	function	Validates the pane form. Overrides CheckoutPaneInterface::validatePaneForm	4
CheckoutPaneBase::__construct	public	function	Constructs a new CheckoutPaneBase object. Overrides PluginBase::__construct	6
DemoCouponCallout::buildPaneForm	public	function	Builds the pane form. Overrides CheckoutPaneInterface::buildPaneForm
DemoCouponCallout::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides CheckoutPaneBase::defaultConfiguration
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.