You are here

Home » API reference » Feed Import 8 » FeedImportBaseSettingsForm.php

class FeedImportBaseSettingsForm in Feed Import 8

Hierarchy

Expanded class hierarchy of FeedImportBaseSettingsForm

1 string reference to 'FeedImportBaseSettingsForm'
feed_import_base.routing.yml in feed_import_base/feed_import_base.routing.yml
feed_import_base/feed_import_base.routing.yml

File

feed_import_base/src/Form/FeedImportBaseSettingsForm.php, line 15
Contains \Drupal\feed_import_base\Form\FeedImportBaseSettingsForm.

Namespace

Drupal\feed_import_base\Form
View source 
class FeedImportBaseSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('feed_import_base.settings');
    foreach (Element::children($form) as $variable) {
      $config
        ->set($variable, $form_state
        ->getValue($form[$variable]['#parents']));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'feed_import_base.settings',
    ];
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('feed_import_base.settings');
    $form['reports'] = [
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('reports'),
      '#title' => t('Provide import reports'),
      '#description' => t('These are log reports.'),
    ];
    $form['use_cron'] = [
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('use_cron'),
      '#title' => t('Cron import'),
      '#description' => t('Run import for enabled feeds at cron'),
    ];
    $form['container'] = [
      '#type' => 'fieldset',
      '#states' => [
        'invisible' => [
          'input[name="use_cron"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['container']['time_settings'] = [
      '#type' => 'radios',
      '#options' => [
        t('From time to time'),
        t('Specified time interval'),
      ],
      '#default_value' => $config
        ->get('time_settings'),
      '#title' => t('When feeds can be imported'),
    ];
    $form['container']['time_between_imports'] = [
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('interval'),
      '#title' => t('Time between two imports at cron (seconds)'),
      '#description' => t('Time betwen two cron imports.'),
      '#states' => [
        'visible' => [
          'input[name="time_settings"]' => [
            'value' => 0,
          ],
        ],
      ],
    ];
    $form['container']['interval_start'] = [
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('interval_start'),
      '#title' => t('Start time'),
      '#description' => t('Format is hh:mm.'),
      '#states' => [
        'visible' => [
          'input[name="time_settings"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];
    $form['container']['interval_stop'] = [
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('interval_stop'),
      '#title' => t('End time'),
      '#description' => t('Format is hh:mm. This must be greater than start time.'),
      '#states' => [
        'visible' => [
          'input[name="time_settings"]' => [
            'value' => 1,
          ],
        ],
      ],
    ];
    $form['delete_items_per_cron'] = [
      '#type' => 'textfield',
      '#default_value' => $config
        ->get('delete_items_per_cron'),
      '#title' => t('Expired items delete per cron'),
      '#description' => t('How many expired items to delete when cron runs.'),
      '#required' => TRUE,
    ];
    $form['filters_dir'] = [
      '#type' => 'textfield',
      '#default_value' => _feed_import_base_get_filters_dir(),
      '#title' => t('Extra filters base path'),
      '#description' => t('Where to look for filter files.'),
    ];
    $form['let_overlap'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#options' => FeedImport::getAllEntities(),
      '#default_value' => $config
        ->get('let_overlap'),
      '#title' => t('Allow import overlap for specified entities'),
      '#description' => t('This is not indicated for nodes.'),
    ];
    $form['invoke_hooks'] = [
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('invoke_hooks'),
      '#title' => t('Invoke hooks on import success or error'),
      '#description' => t('This can be useful for sending alerts.'),
    ];
    return parent::buildForm($form, $form_state);
  }
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $numeric_fields = [
      'feed_import_time_between_imports',
      'feed_import_delete_items_per_cron',
    ];

    // Checking numeric fields.
    foreach ($numeric_fields as &$field) {
      if ($form_state
        ->getValue($field) && !is_numeric($form_state
        ->getValue($field))) {
        $form_state
          ->setError($form[$field], t('Field value must be numeric.'));
      }
    }

    // Check interval.
    $ok = TRUE;
    if ($form_state
      ->getValue('feed_import_interval_start') && !preg_match("/^[0-2][0-9]:[0-5][0-9]\$/", $form_state
      ->getValue('feed_import_interval_start'))) {
      $form_state
        ->setError($form['container']['feed_import_interval_start'], t('Invalid start time.'));
      $ok = FALSE;
    }
    if ($form_state
      ->getValue('feed_import_interval_stop') && !preg_match("/^[0-2][0-9]:[0-5][0-9]\$/", $form_state
      ->getValue('feed_import_interval_stop'))) {
      $form_state
        ->setError($form['container']['feed_import_interval_stop'], t('Invalid end time.'));
      $ok = FALSE;
    }
    if ($ok) {
      if ($form_state
        ->getValue('feed_import_interval_stop') < $form_state
        ->getValue('feed_import_interval_start')) {
        $form_state
          ->setError($form['container']['feed_import_interval_stop'], t('End time must be greater than start time.'));
      }
    }
  }

}

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
FeedImportBaseSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
FeedImportBaseSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FeedImportBaseSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FeedImportBaseSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
FeedImportBaseSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.
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.