You are here

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

class SimpleStockLevelWidget in Commerce Stock 8

Plugin implementation of the 'commerce_stock_level' widget.

@Deprecated: We have now a dedicated widget per use case.

Plugin annotation


@FieldWidget(
  id = "commerce_stock_level_simple",
  module = "commerce_stock_field",
  label = @Translation("Deprecated: Will be removed soon."),
  field_types = {
    "commerce_stock_level"
  }
)

Hierarchy

Expanded class hierarchy of SimpleStockLevelWidget

See also

https://www.drupal.org/project/commerce_stock/issues/2931754

File

modules/field/src/Plugin/Field/FieldWidget/SimpleStockLevelWidget.php, line 33

Namespace

Drupal\commerce_stock_field\Plugin\Field\FieldWidget
View source 
class SimpleStockLevelWidget extends WidgetBase implements ContainerFactoryPluginInterface {
  use ContextCreatorTrait;
  use MessengerTrait;

  /**
   * The Stock Service Manager.
   *
   * @var \Drupal\commerce_stock\StockServiceManager
   */
  protected $stockServiceManager;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, StockServiceManager $simple_stock_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->stockServiceManager = $simple_stock_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('commerce_stock.service_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'transaction_note' => FALSE,
      'entry_system' => 'simple',
      'context_fallback' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * Submits the form.
   */
  public function closeForm($form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->messenger()
      ->addMessage(t('Updated the stock.'));
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Deprecated: This widget is deprecated and will be removed soon. Please choose another widget.');
    $summary[] = $this
      ->t('Entry system: @entry_system', [
      '@entry_system' => $this
        ->getSetting('entry_system'),
    ]);
    if ($this
      ->getSetting('entry_system') != 'transactions') {
      $summary[] = $this
        ->t('Transaction note: @transaction_note', [
        '@transaction_note' => $this
          ->getSetting('transaction_note') ? 'Yes' : 'No',
      ]);
      $summary[] = $this
        ->t('context fallback: @context_fallback', [
        '@context_fallback' => $this
          ->getSetting('context_fallback') ? 'Yes' : 'No',
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $element['deprecation_notiz'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#value' => $this
        ->t('Deprecated: This widget is deprecated and will be removed soon. Please choose another widget.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $field = $items
      ->first();
    $entity = $items
      ->getEntity();
    if (!$entity instanceof PurchasableEntityInterface) {

      // No stock if this is not a purchasable entity.
      return [];
    }
    if ($entity
      ->isNew()) {

      // We can not work with entities before they are fully created.
      return [];
    }

    // We currently only support the Local stock service.
    $stockServiceManager = $this->stockServiceManager;
    $stock_service_name = $stockServiceManager
      ->getService($entity)
      ->getName();

    // @todo - service should be able can determine if it needs an interface.
    if ($stock_service_name != 'Local stock') {

      // Return an empty array if service is not supported.
      return [];
    }

    // If not a valid context.
    try {
      $this
        ->getContext($entity);
    } catch (\Exception $e) {

      // If context fallback is not set.
      if (!$this
        ->getSetting('context_fallback')) {

        // Return an empty form.
        return [];
      }
    }

    // Get the available stock level.
    $level = $field->available_stock;
    $entry_system = $this
      ->getSetting('entry_system');
    $element['#type'] = 'fieldgroup';
    $element['#attributes'] = [
      'class' => [
        'stock-level-field',
      ],
    ];
    $element['#title'] = $this
      ->t('Stock (deprecated)');

    // Set the entry system so we know how to set the value.
    // @see StockLevel::setValue().
    $element['entry_system'] = [
      '#type' => 'value',
      '#value' => $entry_system,
    ];
    if (empty($entity
      ->id())) {

      // We don't have a product ID yet.
      $element['#description'] = [
        '#type' => 'html_tag',
        '#tag' => 'strong',
        '#value' => $this
          ->t('In order to set the stock level you need to save the product first!'),
      ];
      $element['#disabled'] = TRUE;
    }
    else {
      $element['stocked_entity'] = [
        '#type' => 'value',
        '#value' => $entity,
      ];
      if ($entry_system == 'simple') {
        $element['stock_level'] = [
          '#title' => $this
            ->t('Absolute stock level settings'),
          '#description' => $this
            ->t('Sets the stock level. Current stock level: @stock_level. Note: Under the hood we create a transaction. Setting the absolute stock level may end in unexpected results. Learn more about transaction based inventory management in the docs.', [
            '@stock_level' => $level,
          ]),
          '#type' => 'number',
          '#min' => 0,
          '#step' => 1,
          // We don't use zero as default, because its a valid value and would reset
          // the stock level to 0.
          '#default_value' => NULL,
          '#size' => 7,
        ];
      }
      elseif ($entry_system == 'basic') {
        $element['adjustment'] = [
          '#title' => $this
            ->t('Stock level adjustment'),
          '#description' => $this
            ->t('A positive number will add stock, a negative number will remove stock. Current stock level: @stock_level', [
            '@stock_level' => $level,
          ]),
          '#type' => 'number',
          '#step' => 1,
          '#default_value' => 0,
          '#size' => 7,
        ];
      }
      elseif ($entry_system == 'transactions') {
        $element['stock_level_title'] = [
          '#type' => 'html_tag',
          '#tag' => 'div',
          '#value' => $this
            ->t('Current stock level: @stock_level', [
            '@stock_level' => $level,
          ]),
        ];
        $link = Link::createFromRoute($this
          ->t('New transaction'), 'commerce_stock_ui.stock_transactions2', [
          'commerce_product_v_id' => $entity
            ->id(),
        ], [
          'attributes' => [
            'target' => '_blank',
          ],
        ])
          ->toString();
        $element['stock_transactions_form_link'] = [
          '#type' => 'html_tag',
          '#tag' => 'div',
          '#value' => $this
            ->t('Please use the @transaction form to create any stock transactions.', [
            '@transaction' => $link,
          ]),
        ];
      }
      if ($this
        ->getSetting('transaction_note')) {
        $element['stock_transaction_note'] = [
          '#title' => $this
            ->t('Transaction note'),
          '#description' => $this
            ->t('Add a note to this transaction.'),
          '#type' => 'textfield',
          '#default_value' => '',
          '#size' => 50,
          '#maxlength' => 255,
        ];
      }
      $element['deprecation_notiz'] = [
        '#type' => 'html_tag',
        '#tag' => 'div',
        '#value' => $this
          ->t('Deprecated: This widget is deprecated and will be removed soon. Please choose another widget.'),
      ];
    }
    return $element;
  }

  /**
   * Simple stock form - Used to update the stock level.
   *
   * @todo: This is not go live ready code,
   */
  public function validateSimple($element, FormStateInterface $form_state) {
    if (!is_numeric($element['#value'])) {
      $form_state
        ->setError($element, $this
        ->t('Stock must be a number.'));
      return;
    }

    // @todo Needs to mark element as needing updating? Updated qty??
  }

  /**
   * Validates a basic stock field widget form.
   */
  public function validateBasic($element, FormStateInterface $form_state) {

    // @to do.
    return TRUE;
  }

  /**
   * Submits the form.
   */
  public function submitAll(array &$form, FormStateInterface $form_state) {
    $this
      ->messenger()
      ->addMessage($this
      ->t('Updated stock!'));
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    if (isset($values[0]['stock_level'])) {
      if (empty($values[0]['stock_level']) && $values[0]['stock_level'] !== "0") {
        $values[0]['adjustment'] = NULL;
        return $values;
      }
      $new_level = $values[0]['stock_level'];
      $current_level = $this->stockServiceManager
        ->getStockLevel($values[0]['stocked_entity']);
      $values[0]['adjustment'] = $new_level - $current_level;
      return $values;
    }
    return $values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
ContextCreatorTrait::createContextFromOrder public static function Creates a commerce context object.
ContextCreatorTrait::getContext public function Returns the active commerce context.
ContextCreatorTrait::getContextDetails private function Get context details.
ContextCreatorTrait::isValidContext public function Checks that the context returned is valid for $entity.
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
SimpleStockLevelWidget::$stockServiceManager protected property The Stock Service Manager.
SimpleStockLevelWidget::closeForm public function Submits the form.
SimpleStockLevelWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
SimpleStockLevelWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SimpleStockLevelWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
SimpleStockLevelWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
SimpleStockLevelWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
SimpleStockLevelWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
SimpleStockLevelWidget::submitAll public function Submits the form.
SimpleStockLevelWidget::validateBasic public function Validates a basic stock field widget form.
SimpleStockLevelWidget::validateSimple public function Simple stock form - Used to update the stock level.
SimpleStockLevelWidget::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState