download_count.settings.inc in Download Count 7.3

Administrative page callbacks for the download_count module.

File

includes/download_count.settings.inc

<?php

/**
 * @file
 * Administrative page callbacks for the download_count module.
 */

/**
 * Download count administration settings.
 *
 * @return
 * Form for download_count configuration options.
 */
function download_count_admin_settings($form, &$form_state) {
  $form['excluded file extensions'] = array(
    '#type' => 'fieldset',
    '#title' => t('Excluded file extensions'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['excluded file extensions']['download_count_excluded_file_extensions'] = array(
    '#type' => 'textfield',
    '#title' => t('Excluded file extensions'),
    '#default_value' => variable_get('download_count_excluded_file_extensions', 'jpg jpeg gif png'),
    '#maxlength' => 255,
    '#description' => 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'] = array(
    '#type' => 'fieldset',
    '#title' => t('Report page options'),
    '#description' => t('Settings for <a href="@page">this</a> page.', array(
      '@page' => url('admin/reports/download-count'),
    )),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['download count page']['download_count_view_page_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => variable_get('download_count_view_page_title', t('Download Counts')),
  );
  $form['download count page']['download_count_view_page_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Total number of items to display'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_view_page_limit', 0),
    '#description' => t('Set to 0 for no limit.'),
  );
  $form['download count page']['download_count_view_page_items'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of items per page'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_view_page_items', 25),
    '#description' => t('Set to 0 for no pager.'),
  );
  $header = variable_get('download_count_view_page_header', '');
  $form['download count page']['download_count_view_page_header'] = array(
    '#type' => 'text_format',
    '#title' => t('Header'),
    '#format' => isset($header['format']) ? $header['format'] : NULL,
    '#default_value' => isset($header['value']) ? $header['value'] : NULL,
    '#description' => t('Text to appear between the title of the page and the download count table.'),
  );
  $footer = variable_get('download_count_view_page_footer', '');
  $form['download count page']['download_count_view_page_footer'] = array(
    '#type' => 'text_format',
    '#title' => t('Footer'),
    '#format' => isset($footer['format']) ? $footer['format'] : NULL,
    '#default_value' => isset($footer['value']) ? $footer['value'] : NULL,
    '#description' => t('Text to appear underneath the download count table.'),
  );
  $form['details'] = array(
    '#type' => 'fieldset',
    '#title' => t('Details Page Options'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['details']['download_count_details_daily_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of days to display on the details page.'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_details_daily_limit', 30),
  );
  $form['details']['download_count_details_weekly_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of weeks to display on the details page.'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_details_weekly_limit', 25),
  );
  $form['details']['download_count_details_monthly_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of months to display on the details page.'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_details_monthly_limit', 12),
  );
  $form['details']['download_count_details_yearly_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Number of years to display on the details page.'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_details_yearly_limit', 5),
  );
  if (module_exists('libraries')) {
    $plugin = libraries_get_path('jquery.sparkline', FALSE) . '/jquery.sparkline.min.js';
  }
  else {
    $plugin = drupal_get_path('module', 'download_count') . '/jquery.sparkline.min.js';
  }
  if (file_exists($plugin)) {
    $form['details']['sparklines'] = array(
      '#type' => 'fieldset',
      '#title' => t('Sparkline Options'),
      '#description' => '<p>' . t('The jquery sparkline plugin is available at: /') . $plugin . '</p>',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $form['details']['sparklines']['download_count_sparklines'] = array(
      '#type' => 'select',
      '#title' => t('Sparklines'),
      '#default_value' => variable_get('download_count_sparklines', 'line'),
      '#options' => array(
        'none' => t('None'),
        'line' => t('Line'),
        'bar' => t('Bar'),
      ),
      '#disabled' => !$plugin,
      '#description' => 'Enable sparklines and select type.',
    );
    $form['details']['sparklines']['download_count_sparkline_min'] = array(
      '#type' => 'textfield',
      '#title' => t('Chart Minimum Value'),
      '#size' => 8,
      '#default_value' => variable_get('download_count_sparkline_min', '0'),
      '#disabled' => !$plugin,
      '#description' => 'Specify the minimum value to use for the range of the chart (starting point).',
    );
    $form['details']['sparklines']['download_count_sparkline_height'] = array(
      '#type' => 'textfield',
      '#title' => t('Chart Height'),
      '#size' => 8,
      '#default_value' => variable_get('download_count_sparkline_height', '150px'),
      '#disabled' => !$plugin,
      '#description' => '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'] = array(
      '#type' => 'textfield',
      '#title' => t('Chart Width'),
      '#size' => 8,
      '#default_value' => variable_get('download_count_sparkline_width', '50%'),
      '#disabled' => !$plugin,
      '#description' => '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'] = array(
    '#type' => 'fieldset',
    '#title' => t('Flood Control Settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['download_count_flood_control']['download_count_flood_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Flood control limit'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_flood_limit', 0),
    '#description' => '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'] = array(
    '#type' => 'textfield',
    '#title' => t('Flood control window'),
    '#size' => 10,
    '#default_value' => variable_get('download_count_flood_window', 5),
    '#description' => 'Number of seconds in the time window for counting a file download.',
  );
  $form['download_count_cache_clear'] = array(
    '#type' => 'fieldset',
    '#title' => t('Clear Download Count Cache'),
    '#description' => '<p>' . t('This will delete the cached download count data from the database. It will be rebuilt during drupal cron runs.<br /><strong>Note:</strong> This will affect the details page until the data has been rebuilt.') . '</p>',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['download_count_cache_clear']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Clear Cache'),
    '#submit' => array(
      'download_count_clear_submit',
    ),
  );
  return system_settings_form($form);
}

/**
 * Clear cache button submit handler.
 */
function download_count_clear_submit($form, &$form_state) {
  $form_state['redirect'] = 'admin/config/media/download-count/clear';
}

/**
 * Form to confirm clearing of the download_count_cache table.
 */
function download_count_clear_confirm($form, &$form_state) {
  return confirm_form($form, t('Are you sure you want to clear the download count cache?'), 'admin/config/media/download-count', t('This action cannot be undone.'), t('Clear Cache'), t('Cancel'));
}

/**
 * Form submit handler for download_count_clear_confirm().
 */
function download_count_clear_confirm_submit($form, &$form_state) {
  variable_set('download_count_last_cron', 0);
  db_truncate('download_count_cache')
    ->execute();
  drupal_set_message(t('The download count cache has been cleared.'));
  watchdog('download_count', 'The download count cache has been cleared.', array(), WATCHDOG_NOTICE);
  $form_state['redirect'] = 'admin/config/media/download-count';
}

Functions

Name	Description
download_count_admin_settings	Download count administration settings.
download_count_clear_confirm	Form to confirm clearing of the download_count_cache table.
download_count_clear_confirm_submit	Form submit handler for download_count_clear_confirm().
download_count_clear_submit	Clear cache button submit handler.