You are here

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

class CronConfigForm in Commerce Stock 8

Class CronConfigForm.

Hierarchy

Expanded class hierarchy of CronConfigForm

1 string reference to 'CronConfigForm'
commerce_stock_local.routing.yml in modules/local_storage/commerce_stock_local.routing.yml
modules/local_storage/commerce_stock_local.routing.yml

File

modules/local_storage/src/Form/CronConfigForm.php, line 12

Namespace

Drupal\commerce_stock_local\Form
View source 
class CronConfigForm extends ConfigFormBase {

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

  /**
   * Get the editable configuration names.
   *
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'commerce_stock_local.cron',
      'commerce_stock_local.transactions',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $cron_config = $this
      ->config('commerce_stock_local.cron');
    $trns_config = $this
      ->config('commerce_stock_local.transactions');

    // Transaction handling.
    $form['transactions'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Transaction handling'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    ];
    $form['transactions']['aggregation_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Stock aggregation mode'),
      '#options' => [
        'cron' => 'Cron',
        'real-time' => 'Real-time',
      ],
      //'#description' => $this->t('@todo.'),
      '#default_value' => $trns_config
        ->get('transactions_aggregation_mode'),
    ];
    $form['transactions']['transactions_retention'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Transactions retention'),
      '#options' => [
        'keep' => 'Keep all',
        'delete' => 'Delete unused',
      ],
      '#description' => $this
        ->t('Warning: If you set to "Delete unused" you will have no log of your transactions.'),
      '#default_value' => $trns_config
        ->get('transactions_retention'),
    ];

    // Cron configurations.
    $form['cron'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Legacy settings'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    ];
    $form['cron']['cron_run_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Cron run mode'),
      '#options' => [
        'optimal' => 'Optimal',
        'legacy' => 'Legacy/Full',
      ],
      '#description' => $this
        ->t('Optimal - will only update the stats of products with new transactions. Legacy/Full - is the old way of updating stats and will go through all products regardless of their changed state.'),
      '#default_value' => $cron_config
        ->get('cron_run_mode'),
    ];
    $form['cron']['update_interval'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Update interval'),
      '#description' => $this
        ->t('The number of seconds to wait between each cron operation. Set to Zero to run each time cron runs.'),
      '#default_value' => $cron_config
        ->get('update_interval'),
      '#weight' => '0',
    ];

    // Cron legacy settings.
    $form['cron']['legacy'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Legacy settings'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['cron']['legacy']['update_batch_size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Update batch size'),
      '#default_value' => $cron_config
        ->get('update_batch_size'),
      '#weight' => '0',
    ];
    $form['cron']['legacy']['update_batch_size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Update batch size'),
      '#default_value' => $cron_config
        ->get('update_batch_size'),
      '#weight' => '0',
    ];
    $form['cron']['legacy']['reset_update_last_id'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Reset Last processed ID'),
      '#description' => $this
        ->t('This will cause cron to start from the first product.'),
      '#default_value' => FALSE,
    ];
    return parent::buildForm($form, $form_state);
  }

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

    // Get the transaction haqndling form values.
    $transactions_aggregation_mode = $form_state
      ->getValue('aggregation_mode');
    $transactions_retention = $form_state
      ->getValue('transactions_retention');

    // Set the submitted configuration setting.
    $this->configFactory
      ->getEditable('commerce_stock_local.transactions')
      ->set('transactions_aggregation_mode', $transactions_aggregation_mode)
      ->set('transactions_retention', $transactions_retention)
      ->save();

    // Get the cron form values.
    $update_batch_size = $form_state
      ->getValue('update_batch_size');
    $update_interval = $form_state
      ->getValue('update_interval');
    $cron_run_mode = $form_state
      ->getValue('cron_run_mode');
    $reset_update_last_id = $form_state
      ->getValue('reset_update_last_id');

    // Set the submitted configuration setting.
    $this->configFactory
      ->getEditable('commerce_stock_local.cron')
      ->set('update_batch_size', $update_batch_size)
      ->set('update_interval', $update_interval)
      ->set('cron_run_mode', $cron_run_mode)
      ->save();
    if ($reset_update_last_id) {
      \Drupal::state()
        ->set('commerce_stock_local.update_last_id', 0);
    }
    parent::submitForm($form, $form_state);
  }

}

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.
CronConfigForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CronConfigForm::getEditableConfigNames protected function Get the editable configuration names. Overrides ConfigFormBaseTrait::getEditableConfigNames
CronConfigForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CronConfigForm::submitForm public function Form submission handler. Overrides ConfigFormBase::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::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.
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.