public function MatomoReportsSettings::buildForm in Matomo Reports 8

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/MatomoReportsSettings.php, line 64

Class

MatomoReportsSettings

Class MatomoReportsSettings.

Namespace

Drupal\matomo_reports\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('matomo_reports.matomoreportssettings');
  $form['matomo_reports_server'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Matomo report server'),
  ];
  $form['matomo_reports_server']['matomo_server_url'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Matomo Server URL'),
    '#description' => $this
      ->t('The URL to your Matomo base directory, e.g., "https://analytics.example.com/matomo/".'),
    '#maxlength' => 255,
    '#size' => 80,
    '#default_value' => $config
      ->get('matomo_server_url'),
  ];
  $form['token_auth'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Token auth'),
    '#description' => $this
      ->t('To see matomo reports in Drupal you need a <strong>token_auth</strong> value. You can find it in the  <strong>Users</strong> tab under the <strong>Settings</strong> link in your Matomo account or ask your Matomo server administrator.'),
  ];
  $form['token_auth']['matomo_reports_token_auth'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Matomo authentication string'),
    '#description' => $this
      ->t('Leave blank if you prefer each user setting their own, or paste it here to have a global <strong>token_auth</strong>. If anonymous users have view permissions in Matomo you can set this value to <strong>anonymous</strong>. Users still need &quot;Access Matomo reports&quot; permission to see the reports in Drupal.'),
    '#maxlength' => 40,
    '#size' => 40,
    '#default_value' => $config
      ->get('matomo_reports_token_auth'),
  ];
  $form['matomo_reports_sites'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Allowed sites'),
    '#description' => $this
      ->t('List sites you want restrict your users access to.'),
  ];
  $sites = MatomoData::getSites($config
    ->get('matomo_reports_token_auth'));
  $allowed_sites_desc = $this
    ->t('List accessible sites id separated by a comma. Example: &quot;1,4,12&quot;. Leave blank to let users see all sites accessible on matomo server with current token auth (highly recommended in case of per user token auth).');
  if (is_array($sites) && count($sites)) {
    if ($config
      ->get('matomo_reports_token_auth')) {
      $allowed_sites_desc .= ' ' . $this
        ->t('Sites currently accessible with global token_auth are:');
    }
    else {
      $allowed_sites_desc .= ' ' . $this
        ->t('Sites current accessible as anonymous are:');
    }
    foreach ($sites as $site) {
      $allowed_sites_desc .= '<br />' . (int) $site['idsite'] . ' - ' . Html::escape($site['name']);
    }
  }
  else {
    $allowed_sites_desc .= ' ' . $this
      ->t('No accessible sites are available with current global token auth. Please check your token auth is correct and that it has view permission on Matomo server.');
  }
  $form['matomo_reports_sites']['matomo_reports_allowed_sites'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Allowed sites'),
    '#description' => $allowed_sites_desc,
    '#maxlength' => 64,
    '#size' => 64,
    '#default_value' => $config
      ->get('matomo_reports_allowed_sites'),
  ];
  return parent::buildForm($form, $form_state);
}