You are here

Home » API reference » Commerce Stock 8 » StockEnforcementConfigForm.php

class StockEnforcementConfigForm in Commerce Stock 8

The stock enforcement configuration form.

Hierarchy

Expanded class hierarchy of StockEnforcementConfigForm

1 string reference to 'StockEnforcementConfigForm'
commerce_stock_enforcement.routing.yml in modules/enforcement/commerce_stock_enforcement.routing.yml
modules/enforcement/commerce_stock_enforcement.routing.yml

File

modules/enforcement/src/Form/StockEnforcementConfigForm.php, line 11

Namespace

Drupal\commerce_stock_enforcement\Form
View source 
class StockEnforcementConfigForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'commerce_stock_enforcement_config_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Get the default service.
    $config = $this
      ->config('commerce_stock_enforcement.settings');
    $message_data = [
      'insufficient_stock_cart' => [
        'title' => 'Insufficient stock: Cart page',
        'description' => 'This is shown on the cart page on load and when submitted.',
        'tokens' => [
          '%name: ' . $this
            ->t('The title of the purchased entity.'),
          '%qty: ' . $this
            ->t('The stock level of the item.'),
        ],
      ],
      'insufficient_stock_add_to_cart_zero_in_cart' => [
        'title' => 'Insufficient stock: Add to cart form (0 in cart)',
        'description' => 'This is shown on the add to cart form when the customer doesn\'t have any of this item in their cart already.',
        'tokens' => [
          '%qty: ' . $this
            ->t('The stock level of the item.'),
          '%qty_asked: ' . $this
            ->t('The quantity requested.'),
        ],
      ],
      'insufficient_stock_add_to_cart_quantity_in_cart' => [
        'title' => 'Insufficient stock: Add to cart form (quantity in cart)',
        'description' => 'This is shown on the add to cart form when the customer has this item in their cart already.',
        'tokens' => [
          '%qty: ' . $this
            ->t('The stock level of the item.'),
          '%qty_o: ' . $this
            ->t('The quantity already in cart.'),
        ],
      ],
    ];

    // Message customisation.
    $message_settings = 'message_settings';
    $form[$message_settings] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Message text'),
    ];

    // Add the textarea for each message.
    foreach ($message_data as $element_name => $data) {
      $form[$message_settings][$element_name] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('@title', [
          '@title' => $data['title'],
        ]),
        '#default_value' => $config
          ->get($element_name) ?? '',
      ];

      // Add the token info.
      $list = [
        '#theme' => 'item_list',
        '#items' => $data['tokens'],
        '#prefix' => ' ' . $this
          ->t('Available tokens:'),
      ];
      $form[$message_settings][$element_name]['#description'][] = [
        '#markup' => $this
          ->t('@data', [
          '@data' => $data['description'],
        ]),
      ];
      $form[$message_settings][$element_name]['#description'][] = $list;
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $config = $this
      ->config('commerce_stock_enforcement.settings');
    $config
      ->set('insufficient_stock_cart', $values['insufficient_stock_cart']);
    $config
      ->set('insufficient_stock_add_to_cart_zero_in_cart', $values['insufficient_stock_add_to_cart_zero_in_cart']);
    $config
      ->set('insufficient_stock_add_to_cart_quantity_in_cart', $values['insufficient_stock_add_to_cart_quantity_in_cart']);
    $config
      ->save();
    $this
      ->messenger()
      ->addMessage($this
      ->t('Stock enforcement settings updated.'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'commerce_stock_enforcement.settings',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
StockEnforcementConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
StockEnforcementConfigForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StockEnforcementConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
StockEnforcementConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.