You are here

public function IpBanAdmin::buildForm in IP Ban 8

Same name in this branch
  1. 8 src/IpBanAdmin.php \Drupal\ip_ban\IpBanAdmin::buildForm()
  2. 8 src/Form/IpBanAdmin.php \Drupal\ip_ban\Form\IpBanAdmin::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/IpBanAdmin.php, line 35

Class

IpBanAdmin

Namespace

Drupal\ip_ban\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $form = [];
  $form['#attached']['library'][] = 'ip_ban/ip_ban.admin_form';

  // Add a second submit button.
  $form['top_submit_button'] = [
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  ];

  // $form['ip_ban_readonly'] = [
  // '#type' => 'textfield',
  // '#title' => t('Read Only Message'),
  // '#default_value' => \Drupal::config('ip_ban.settings')->get('ip_ban_readonly'),
  // '#description' => t('The message that a user from a country set to "Read Only" will see when they attempt to access any /user/* page on this website. This message will be shown and highlighted as an error.'),
  // '#size' => 100,
  // '#maxlength' => 256,
  // ];
  $form['ip_ban_readonly_path'] = [
    '#type' => 'textfield',
    '#title' => t('Page to redirect to if user attempts to access any user/* page based on read-only access'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_readonly_path'),
    '#description' => t('Enter a valid internal path, such as "/node/1" or "/content/read-only".'),
    '#required' => TRUE,
    '#size' => 100,
    '#maxlength' => 256,
  ];
  $form['ip_ban_completeban'] = [
    '#type' => 'textfield',
    '#title' => t('Complete Ban Message'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_completeban'),
    '#description' => t('The message that a user from a country set to "Complete Ban" will see when they try to access any page on this website (except the access denied or redirect page. This message will be shown and highlighted as an error.'),
    '#size' => 100,
    '#maxlength' => 256,
  ];
  $form['ip_ban_completeban_path'] = [
    '#type' => 'textfield',
    '#title' => t('Page to redirect to if user attempts to access any webpage based on "Complete Ban" access'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_completeban_path'),
    '#description' => t('Enter a valid internal path, such as "/node/1" or "/content/banned". If no path is provided, the user will only see an error message on every page.'),
    '#size' => 100,
    '#maxlength' => 256,
  ];
  $options = [
    IP_BAN_NOBAN => '',
    IP_BAN_READONLY => t('Read Only'),
    IP_BAN_BANNED => t('Complete Ban'),
  ];
  $form['ip_ban_setdefault'] = [
    '#type' => 'select',
    '#title' => t('Dynamically set the default value for each country.'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_setdefault'),
    '#description' => t('Apply this setting once before you override individual countries below.'),
    '#options' => $options,
  ];

  // This is a dummy element used to iterate through its children when
  // the country options table is themed.
  $form['ip_ban_table'] = [
    // '#theme' => 'ip_ban_country_table',
    '#type' => 'details',
    '#title' => t('Country Listing Table'),
    '#open' => TRUE,
  ];

  // Add each country selector as a child of the dummy element.
  $countries = \Drupal::service('country_manager')
    ->getStandardList();
  foreach ($countries as $country_code => $country_name) {
    $form_name = 'ip_ban_' . $country_code;
    $this->country_short_names[] = $form_name;
    $form['ip_ban_table'][$form_name] = [
      '#type' => 'select',
      '#title' => t($country_name
        ->getUntranslatedString()),
      '#options' => $options,
      '#default_value' => \Drupal::config('ip_ban.settings')
        ->get($form_name),
      '#attributes' => [
        'class' => [
          'ip-ban-table-cell',
        ],
      ],
    ];
  }
  $form['ip_ban_additional_ips'] = [
    '#type' => 'textarea',
    '#title' => t('Enter additional individual IP addresses to ban'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_additional_ips'),
    '#description' => t('Add one IPV4 address per line. Example:<br/>127.0.0.1<br/>156.228.60.110'),
  ];
  $form['ip_ban_readonly_ips'] = [
    '#type' => 'textarea',
    '#title' => t('Enter additional individual IP addresses to allow read-only access'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_readonly_ips'),
    '#description' => t('Add one IPV4 address per line. Example:<br/>127.0.0.1<br/>156.228.60.110'),
  ];
  $form['ip_ban_disabled_blocks'] = [
    '#type' => 'textarea',
    '#title' => t('Enter blocks to disable for users in "read only" mode'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_disabled_blocks'),
    '#description' => t('<p>Add one module name (that implements the block) and delta per line, separated by a comma. If you are unsure of the module name or delta, navigate to the block configuration page. The module name will be the third to last part of the URI, and the delta will be the second to last. For example, for /admin/structure/block/manage/user/login/configure, enter "user,login" without the quotes. For a custom block like /admin/structure/block/manage/block/11/configure, enter "block,11" without the quotes.</p><p><strong>Note</strong>: there is no validation to determine if the blocks entered are enabled for any enabled theme or the admin theme.</p>'),
    '#element_validate' => array(
      array(
        $this,
        'iPBanDisabledBlocksValidate',
      ),
    ),
  ];
  $form['ip_ban_test_ip'] = [
    '#type' => 'textfield',
    '#title' => t('Test IP address'),
    '#default_value' => \Drupal::config('ip_ban.settings')
      ->get('ip_ban_test_ip'),
    '#description' => t('Enter one valid IPV4 address to test your settings. Example: 156.228.60.110'),
  ];
  $form = parent::buildForm($form, $form_state);
  return $form;
}