public function DownloadCountSettingsForm::buildForm in Download Count 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/DownloadCountSettingsForm.php, line 31

Class

DownloadCountSettingsForm

Configure download count settings.

Namespace

Drupal\download_count\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('download_count.settings');
  $form['excluded file extensions'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Excluded file extensions'),
    '#open' => TRUE,
  ];
  $form['excluded file extensions']['download_count_excluded_file_extensions'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Excluded file extensions'),
    '#default_value' => $config
      ->get('download_count_excluded_file_extensions'),
    '#maxlength' => 255,
    '#description' => $this
      ->t("To exclude files of certain types, enter the extensions to exclude separated by spaces. This is useful if you have private image fields and don't wish to include them in download counts."),
  ];
  $form['download count page'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Report page options'),
    '#description' => $this
      ->t('Settings for <a href="@page">this</a> page.', [
      '@page' => Url::fromRoute('download_count.clear'),
    ]),
    '#open' => FALSE,
  ];
  $form['download count page']['download_count_view_page_title'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Title'),
    '#default_value' => $config
      ->get('download_count_view_page_title'),
  ];
  $form['download count page']['download_count_view_page_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Total number of items to display'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_view_page_limit'),
    '#description' => $this
      ->t('Set to 0 for no limit.'),
  ];
  $form['download count page']['download_count_view_page_items'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Number of items per page'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_view_page_items'),
    '#description' => $this
      ->t('Set to 0 for no pager.'),
  ];
  $header = $config
    ->get('download_count_view_page_header');
  $form['download count page']['download_count_view_page_header'] = [
    '#type' => 'text_format',
    '#title' => $this
      ->t('Header'),
    '#format' => isset($header['format']) ? $header['format'] : NULL,
    '#default_value' => isset($header['value']) ? $header['value'] : NULL,
    '#description' => $this
      ->t('Text to appear between the title of the page and the download count table.'),
  ];
  $footer = $config
    ->get('download_count_view_page_footer');
  $form['download count page']['download_count_view_page_footer'] = [
    '#type' => 'text_format',
    '#title' => $this
      ->t('Footer'),
    '#format' => isset($footer['format']) ? $footer['format'] : NULL,
    '#default_value' => isset($footer['value']) ? $footer['value'] : NULL,
    '#description' => $this
      ->t('Text to appear underneath the download count table.'),
  ];
  $form['details'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Details Page Options'),
    '#open' => FALSE,
  ];
  $form['details']['download_count_details_daily_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Number of days to display on the details page.'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_details_daily_limit'),
  ];
  $form['details']['download_count_details_weekly_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Number of weeks to display on the details page.'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_details_weekly_limit'),
  ];
  $form['details']['download_count_details_monthly_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Number of months to display on the details page.'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_details_monthly_limit'),
  ];
  $form['details']['download_count_details_yearly_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Number of years to display on the details page.'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_details_yearly_limit'),
  ];
  $plugin = DRUPAL_ROOT . '/libraries/sparkline/jquery.sparkline.min.js';
  if (file_exists($plugin)) {
    $form['details']['sparklines'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Sparkline Options'),
      '#description' => '<p>' . $this
        ->t('The jquery sparkline plugin is available at: @plugin', [
        '@plugin' => $plugin,
      ]) . '</p>',
      '#open' => FALSE,
    ];
    $form['details']['sparklines']['download_count_sparklines'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Sparklines'),
      '#default_value' => $config
        ->get('download_count_sparklines'),
      '#options' => [
        'none' => $this
          ->t('None'),
        'line' => $this
          ->t('Line'),
        'bar' => $this
          ->t('Bar'),
      ],
      '#disabled' => !$plugin,
      '#description' => $this
        ->t('Enable sparklines and select type.'),
    ];
    $form['details']['sparklines']['download_count_sparkline_min'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Chart Minimum Value'),
      '#size' => 8,
      '#default_value' => $config
        ->get('download_count_sparkline_min'),
      '#disabled' => !$plugin,
      '#description' => $this
        ->t('Specify the minimum value to use for the range of the chart (starting point).'),
    ];
    $form['details']['sparklines']['download_count_sparkline_height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Chart Height'),
      '#size' => 8,
      '#default_value' => $config
        ->get('download_count_sparkline_height'),
      '#disabled' => !$plugin,
      '#description' => $this
        ->t('The height of the sparkline graph. May be any valid css height (ie 1.5em,20px, etc). Must include units.'),
    ];
    $form['details']['sparklines']['download_count_sparkline_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Chart Width'),
      '#size' => 8,
      '#default_value' => $config
        ->get('download_count_sparkline_width'),
      '#disabled' => !$plugin,
      '#description' => $this
        ->t('The width of the sparkline graph. May be any valid css width (ie 1.5em, 20px, etc). Must include units.'),
    ];
  }
  $form['download_count_flood_control'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Flood Control Settings'),
    '#open' => FALSE,
  ];
  $form['download_count_flood_control']['download_count_flood_limit'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Flood control limit'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_flood_limit'),
    '#description' => $this
      ->t('Maximum number of times to count the file download per time window. Enter 0 for no flood control limits.'),
  ];
  $form['download_count_flood_control']['download_count_flood_window'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Flood control window'),
    '#size' => 10,
    '#default_value' => $config
      ->get('download_count_flood_window'),
    '#description' => $this
      ->t('Number of seconds in the time window for counting a file download.'),
  ];
  $form['download_count_cache_clear'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Clear Download Count Cache'),
    '#description' => '<p>' . $this
      ->t('This will delete the cached download count data from the database. It
             will be rebuilt during drupal cron runs.') . '<br /><strong>' . $this
      ->t('Note:') . '</strong>' . $this
      ->t('This will affect the details page until the data has been rebuilt.') . '</p>',
    '#open' => FALSE,
  ];
  $form['download_count_cache_clear']['submit'] = [
    '#type' => 'submit',
    '#value' => $this
      ->t('Clear Cache'),
    '#submit' => [
      '::downloadCountClearSubmit',
    ],
  ];
  return parent::buildForm($form, $form_state);
}