You are here

class SettingsForm in Replication 8

Same name and namespace in other branches
  1. 8.2 src/Form/SettingsForm.php \Drupal\replication\Form\SettingsForm

Class SettingsForm.

@package Drupal\replication\Form

Hierarchy

Expanded class hierarchy of SettingsForm

File

src/Form/SettingsForm.php, line 13

Namespace

Drupal\replication\Form
View source
class SettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('replication.settings');
    $options = [
      'uid' => $this
        ->t('Map by UID'),
      'anonymous' => $this
        ->t('Map to Anonymous'),
      'uid_1' => $this
        ->t('Map to UID 1'),
    ];
    $form['config'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Replication configuration'),
    );
    $form['config']['mapping_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Users mapping type'),
      '#default_value' => $config
        ->get('mapping_type'),
      '#options' => $options,
      '#description' => $this
        ->t("Select how users will be mapped when they can't be mapped by username or email."),
    ];
    $form['config']['uid'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('UID'),
      '#default_value' => $config
        ->get('mapping_type') === 'uid' ? $config
        ->get('uid') : '',
      '#maxlength' => 60,
      '#size' => 30,
      '#states' => [
        'visible' => [
          'select[name="mapping_type"]' => [
            'value' => 'uid',
          ],
        ],
      ],
    ];
    $form['config']['changes_limit'] = [
      '#type' => 'number',
      '#title' => t('Changes limit'),
      '#default_value' => $config
        ->get('changes_limit'),
      '#description' => $this
        ->t("This is the limit of changes the \n      replicator will GET per request, if the limit is a smaller number than \n      the total changes, then it will do multiple requests to get all the \n      changes. The bigger this number is, the slower will be the request, but at \n      the same time - the smaller is the limit, the higher is the number of \n      requests, so, there should be set an optimal limit, to not impact the \n      performance. Values range 10 - 1000."),
      '#required' => TRUE,
      '#min' => 10,
      '#max' => 1000,
      '#step' => 10,
    ];
    $form['config']['bulk_docs_limit'] = [
      '#type' => 'number',
      '#title' => t('Bulk docs limit'),
      '#default_value' => $config
        ->get('bulk_docs_limit'),
      '#description' => $this
        ->t("This is the limit of entities the \n      replicator will POST per request, if the limit is a smaller number than \n      the total number of entities that have to be transferred to the destination, \n      then it will do multiple requests to transfer all the entities. The bigger \n      this number is, the slower will be the request and the destination site will \n      need more resources to process all the data, so, there should be set an \n      optimal limit, to not impact the performance. Values range 10 - 1000."),
      '#required' => TRUE,
      '#min' => 10,
      '#max' => 1000,
      '#step' => 10,
    ];
    $form['config']['replication_execution_limit'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Replication execution limit'),
      '#default_value' => $config
        ->get('replication_execution_limit'),
      '#options' => [
        1 => $this
          ->t('1 hour'),
        2 => $this
          ->t('2 hours'),
        4 => $this
          ->t('4 hours'),
        8 => $this
          ->t('8 hours'),
      ],
      '#description' => $this
        ->t("The maximum time a replication can run, if it exceeds this time then the replication is marked as failed."),
      '#required' => TRUE,
    ];
    $form['config']['verbose_logging'] = [
      '#type' => 'checkbox',
      '#title' => t('Verbose logging'),
      '#default_value' => (int) $config
        ->get('verbose_logging'),
      '#description' => $this
        ->t('This will enable verbose replication logging.'),
    ];
    $form['config']['actions']['#type'] = 'actions';
    $form['config']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];

    // By default, render the form using system-config-form.html.twig.
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $storage = \Drupal::entityTypeManager()
      ->getStorage('user');
    $uid = trim($form_state
      ->getValue('uid'));
    if ($form_state
      ->getValue('mapping_type') === 'uid' && is_numeric($uid)) {
      if (!$storage
        ->load($uid)) {
        $form_state
          ->setErrorByName('uid', "Provided UID doesn't exist.");
      }
    }
    elseif ($form_state
      ->getValue('mapping_type') === 'uid' && !is_numeric($uid)) {
      $form_state
        ->setErrorByName('uid', 'Empty or wrong format for the UID field.');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('replication.settings');
    $mapping_type = $form_state
      ->getValue('mapping_type');
    switch ($mapping_type) {
      case 'uid':
        $uid = $form_state
          ->getValue('uid');
        break;
      case 'anonymous':
        $uid = 0;
        break;
      case 'uid_1':
        $uid = 1;
        break;
      default:
        $uid = NULL;
    }
    $changes_limit = $form_state
      ->getValue('changes_limit');
    $bulk_docs_limit = $form_state
      ->getValue('bulk_docs_limit');
    $replication_execution_limit = $form_state
      ->getValue('replication_execution_limit');
    $verbose_logging = (bool) $form_state
      ->getValue('verbose_logging');
    $config
      ->set('mapping_type', $mapping_type)
      ->set('changes_limit', $changes_limit)
      ->set('bulk_docs_limit', $bulk_docs_limit)
      ->set('replication_execution_limit', $replication_execution_limit)
      ->set('verbose_logging', $verbose_logging)
      ->set('uid', trim($uid))
      ->save();
  }

}

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