class AddToCartForm in Ubercart 8.4

Defines a complex form for adding a product to the cart.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\uc_product\Form\BuyItNowForm implements BaseFormIdInterface
    • class \Drupal\uc_product\Form\AddToCartForm

2 files declare their use of AddToCartForm

AddToCart.php in uc_product/src/Plugin/views/field/AddToCart.php

uc_product.module in uc_product/uc_product.module

The product module for Ubercart.

File

uc_product/src/Form/AddToCartForm.php, line 11

Namespace

Drupal\uc_product\Form

class AddToCartForm extends BuyItNowForm {

  /**
   * Constructs an AddToCartForm.
   *
   * @param string $nid
   *   The node ID.
   */
  public function __construct($nid) {
    parent::__construct($nid);
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() {

    // Base Form ID allows us to theme all add-to-cart-forms using the same
    // CSS class and twig template, and allows us to hook_form_BASE_ID_ALTER()
    // all add-to-cart-forms, rather than having to target each individual form.
    return 'uc_product_add_to_cart_form';
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {

    // Form ID must be unique to the product so that we may have multiple
    // add-to-cart forms on a page (e.g. in a catalog view).
    return 'uc_product_add_to_cart_form_' . $this->nid;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, NodeInterface $node = NULL) {
    $form = parent::buildForm($form, $form_state, $node);
    $form['node'] = [
      '#type' => 'value',
      '#value' => $form_state
        ->get('variant') ?: $node,
    ];
    if ($node->default_qty->value > 0) {
      if ($this
        ->config('uc_product.settings')
        ->get('add_to_cart_qty')) {
        $form['qty'] = [
          '#type' => 'uc_quantity',
          '#title' => $this
            ->t('Quantity'),
          '#default_value' => $node->default_qty->value,
        ];
      }
      else {
        $form['qty']['#value'] = $node->default_qty->value;
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $data = \Drupal::moduleHandler()
      ->invokeAll('uc_add_to_cart_data', [
      $form_state
        ->getValues(),
    ]);
    $form_state
      ->set('variant', uc_product_load_variant($form_state
      ->getValue('nid'), $data));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddToCartForm::buildForm	public	function	Form constructor. Overrides BuyItNowForm::buildForm
AddToCartForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BuyItNowForm::getBaseFormId
AddToCartForm::getFormId	public	function	Returns a unique string identifying the form. Overrides BuyItNowForm::getFormId
AddToCartForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
AddToCartForm::__construct	public	function	Constructs an AddToCartForm. Overrides BuyItNowForm::__construct
BuyItNowForm::$nid	protected	property	Node ID of product this form is attached to.
BuyItNowForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.