You are here

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

abstract class StockLevelWidgetBase in Commerce Stock 8

Provides the base structure for commerce stock level widgets.

Hierarchy

Expanded class hierarchy of StockLevelWidgetBase

File

modules/field/src/Plugin/Field/FieldWidget/StockLevelWidgetBase.php, line 18

Namespace

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

  /**
   * 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 $stock_service_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->stockServiceManager = $stock_service_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 [
      'custom_transaction_note' => FALSE,
      'default_transaction_note' => t('Transaction issued by stock level field.'),
      'step' => '1',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('step') == 1) {
      $summary[] = $this
        ->t('Decimal stock levels not allowed');
    }
    else {
      $summary[] = $this
        ->t('Decimal stock levels allowed');
      $summary[] = $this
        ->t('Step: @step', [
        '@step' => $this
          ->getSetting('step'),
      ]);
    }
    $summary[] = $this
      ->t('Default transaction note: @transaction_note', [
      '@transaction_note' => $this
        ->getSetting('default_transaction_note'),
    ]);
    $summary[] = $this
      ->t('Custom transaction note @allowed allowed.', [
      '@allowed' => $this
        ->getSetting('custom_transaction_note') ? '' : 'not',
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $element = [];
    if ($this
      ->hasHelpText()) {
      $element = [
        '#type' => 'html_tag',
        '#tag' => 'div',
        '#value' => $this
          ->getHelpText(),
      ];
    }
    $element['default_transaction_note'] = [
      '#title' => $this
        ->t('Default transaction note'),
      '#description' => $this
        ->t('Use this as default transaction note.'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('default_transaction_note'),
      '#size' => 50,
      '#maxlength' => 255,
    ];
    $element['custom_transaction_note'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow custom note per transaction.'),
      '#default_value' => $this
        ->getSetting('custom_transaction_note'),
    ];

    // Shameless borrowed from commerce quantity field.
    $step = $this
      ->getSetting('step');
    $element['#element_validate'][] = [
      get_class($this),
      'validateSettingsForm',
    ];
    $element['allow_decimal'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow decimal quantities'),
      '#default_value' => $step != '1',
    ];
    $element['step'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Step'),
      '#description' => $this
        ->t('Only stock levels that are multiples of the selected step will be allowed. Maximum precision is 2 (0.01).'),
      '#default_value' => $step != '1' ? $step : '0.1',
      '#options' => [
        '0.1' => '0.1',
        '0.01' => '0.01',
        '0.25' => '0.25',
        '0.5' => '0.5',
        '0.05' => '0.05',
      ],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][allow_decimal]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#required' => TRUE,
    ];
    return $element;
  }

  /**
   * Validates the settings form.
   *
   * @param array $element
   *   The settings form element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  public static function validateSettingsForm(array $element, FormStateInterface $form_state) {
    $value = $form_state
      ->getValue($element['#parents']);
    if (empty($value['allow_decimal'])) {
      $value['step'] = '1';
    }
    unset($value['allow_decimal']);
    $form_state
      ->setValue($element['#parents'], $value);
  }

  /**
   * {@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 [];
    }

    /** @var \Drupal\commerce_stock\StockServiceInterface $stock_service */
    $stock_service = $this->stockServiceManager
      ->getService($entity);
    if ($stock_service
      ->getId() === 'always_in_stock') {

      // Return an empty array if service is not supported.
      return [];
    }
    $element['#type'] = 'fieldgroup';
    $element['#attributes'] = [
      'class' => [
        'stock-level-field',
      ],
    ];

    // If not a valid context.
    if (!$this
      ->isValidContext($entity)) {
      $element['#description'] = [
        '#type' => 'html_tag',
        '#tag' => 'div',
        '#value' => $this
          ->t('We have no valid data to process a stock transaction. This may happen if we cannot determine a store to which the entity belongs to.'),
      ];

      // In case we have no valid context and a new entity, we probably have
      // a inline form at hand.
      if ($entity->isNew) {
        $element['#description']['#value'] = $this
          ->t('We have no valid data to process a stock transaction. Probably because you use an inline form and the parent entity is not saved yet. In such a case you first need to create and save the entity. On the edit form you should be able to set the stock level.');
      }
      return $element;
    }

    // Get the available stock level.
    $level = $field
      ->get('available_stock')
      ->getValue();
    $element['stocked_entity'] = [
      '#type' => 'value',
      '#value' => $entity,
    ];
    $element['adjustment'] = [
      '#title' => $this
        ->t('Stock level adjustment'),
      '#description' => $this
        ->t('A positive number will add stock, a negative number will remove stock.'),
      '#type' => 'number',
      '#step' => $this
        ->getSetting('step'),
      '#default_value' => 0,
      '#size' => 7,
      '#weight' => 20,
    ];
    $element['current level'] = [
      '#markup' => $this
        ->t('Current stock level: @stock_level', [
        '@stock_level' => $level,
      ]),
      '#prefix' => '<div class="stock-level-field-stock-level">',
      '#suffix' => '</div>',
      '#type' => 'markup',
      '#weight' => 10,
    ];
    $custom_note_allowed = $this
      ->getSetting('custom_transaction_note');
    $element['stock_transaction_note'] = [
      '#title' => $this
        ->t('Transaction note'),
      '#description' => $custom_note_allowed ? $this
        ->t('Add a note to this transaction.') : $this
        ->t('Default note for transactions. Configurable in the field widget settings.'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('default_transaction_note'),
      '#size' => 50,
      '#maxlength' => 255,
      '#disabled' => !$custom_note_allowed,
      '#weight' => 50,
    ];
    return $element;
  }

  /**
   * Provides the help text to explain the widgets use case. Used in settings
   * form.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup|null
   *   The help text or NULL.
   */
  protected abstract function getHelpText();

  /**
   * Whether a help text is available.
   *
   * @return bool
   *   TRUE if a help text is availabel, FALSE otherwise.
   */
  private function hasHelpText() {
    return !empty($this
      ->getHelpText());
  }

}

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
StockLevelWidgetBase::$stockServiceManager protected property The Stock Service Manager.
StockLevelWidgetBase::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
StockLevelWidgetBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
StockLevelWidgetBase::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement 2
StockLevelWidgetBase::getHelpText abstract protected function Provides the help text to explain the widgets use case. Used in settings form. 2
StockLevelWidgetBase::hasHelpText private function Whether a help text is available.
StockLevelWidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
StockLevelWidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
StockLevelWidgetBase::validateSettingsForm public static function Validates the settings form.
StockLevelWidgetBase::__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::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState