forms.inc in Quant 6

Form-building functions

File

includes/forms.inc

<?php

/**
 * @file
 *   Form-building functions
 */

/**
 * Provide a simple form to change time periods
 */
function quant_time_form() {
  $form = array();

  // If jQuery UI, load some javascript for datepicker
  if (module_exists('jquery_ui')) {
    jquery_ui_add(array(
      'ui.datepicker',
    ));
    drupal_add_css(drupal_get_path('module', 'quant') . '/theme/datepicker.css');
    drupal_add_js("\n      \$(document).ready(function() {\n        \$('#edit-custom-to').datepicker();\n        \$('#edit-custom-from').datepicker();\n      });\n    ", 'inline');
  }
  $period_options = array(
    '1_week' => t('1 week'),
    '2_weeks' => t('2 weeks'),
    '1_month' => t('1 month'),
    '3_months' => t('3 months'),
    '6_months' => t('6 months'),
    '1_year' => t('1 year'),
    '2_years' => t('2 years'),
  );
  $period = filter_xss($_GET['period']);
  if (!$period || !array_key_exists($period, $period_options)) {
    $period = '1_month';

    // Default value
  }
  $form['message'] = array(
    '#type' => 'item',
    '#value' => t('Select a timeframe and click Update to see what\'s happening on your site during that time, as well as a total for all the activity during that timeframe.'),
  );
  $form['option'] = array(
    '#type' => 'radios',
    '#options' => array(
      'period' => '',
      'custom' => '',
    ),
    '#default_value' => isset($_GET['option']) ? filter_xss($_GET['option']) : 'period',
  );
  $form['period'] = array(
    '#type' => 'select',
    '#options' => $period_options,
    '#default_value' => $period,
  );
  $form['custom_from'] = array(
    '#type' => 'textfield',
    '#size' => 10,
    '#default_value' => isset($_GET['from']) ? filter_xss($_GET['from']) : '',
  );
  $form['custom_to'] = array(
    '#type' => 'textfield',
    '#size' => 10,
    '#default_value' => isset($_GET['to']) ? filter_xss($_GET['to']) : '',
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update'),
  );
  return $form;
}

/**
 * Validate handler for quant_time_form()
 */
function quant_time_form_validate($form, &$form_state) {
  $values = $form_state['values'];

  // Make sure a time option is checked
  if (!$values['option']) {
    form_set_error('error', t('An option must be selected'));
  }

  // If custom option, make sure we have both dates
  if ($values['option'] == 'custom' && !($values['custom_from'] && $values['custom_to'])) {
    form_set_error('option', t('You must specify both dates'));
  }
  else {
    if ($values['option'] == 'custom') {

      // Convert the times
      $now = time();
      $from = strtotime($values['custom_from']);
      $to = strtotime($values['custom_to']);

      // Make sure from date exists
      if (!$from) {
        form_set_error('custom_from', t('The from date must be formatted correctly %format.', array(
          '%format' => '(MM/DD/YY)',
        )));
      }

      // Make sure to date exists
      if (!$to) {
        form_set_error('custom_to', t('The to date must be formatted correctly %format.', array(
          '%format' => '(MM/DD/YY)',
        )));
      }

      // Make sure from is less than to
      if ($from > $to) {
        form_set_error('custom_from', t('The from date must be before the to date'));
      }

      // Make sure to date is not past current time
      if ($to > $now) {
        form_set_error('custom_to', t('The to date must not be past today'));
      }
    }
  }
}

/**
 * Submit handler for quant_time_form()
 */
function quant_time_form_submit(&$form, $form_state) {

  // Add a query to the URL which will be used to determine the query
  switch ($form_state['values']['option']) {
    case 'period':
      drupal_goto('analytics', 'option=period&period=' . $form_state['values']['period']);
      break;
    case 'custom':
      drupal_goto('analytics', 'option=custom&from=' . $form_state['values']['custom_from'] . '&to=' . $form_state['values']['custom_to']);
      break;
  }
}

/**
 * Provide admin settings form
 */
function quant_admin_settings() {
  quant_include('chart');
  $form = array();
  $form['view'] = array(
    '#type' => 'fieldset',
    '#title' => t('View analytics'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['view']['view_link'] = array(
    '#type' => 'item',
    '#value' => l(t('Click here to view the analytics page'), 'analytics'),
  );

  // Get available quants
  $options = array();
  $quants = quant_get_quants();
  foreach ($quants as $quant) {
    $options[$quant->id] = $quant->label;
  }

  // Generate default quant selection
  $default = array();
  if (!($default = variable_get('quant_visible', array()))) {
    if (empty($default)) {
      foreach ($options as $id => $label) {
        $default[] = $id;
      }
    }
  }
  $form['display'] = array(
    '#type' => 'fieldset',
    '#title' => t('Display settings'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['display']['quant_visible'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Show analytics for the following site items'),
    '#default_value' => $default,
    '#options' => $options,
    '#description' => t('The checked objects will be shown on the analytics page. If a quant object is missing from this list, try clearing the cache.'),
  );
  $form['display']['quant_width'] = array(
    '#type' => 'textfield',
    '#title' => t('Chart width'),
    '#default_value' => variable_get('quant_width', 500),
    '#size' => 6,
    '#maxlength' => 4,
    '#required' => TRUE,
    '#description' => t('Specify the graph width in pixels. The Chart API will reject charts that are too wide.'),
  );
  $form['display']['quant_height'] = array(
    '#type' => 'textfield',
    '#title' => t('Chart height'),
    '#default_value' => variable_get('quant_height', 200),
    '#size' => 6,
    '#maxlength' => 4,
    '#required' => TRUE,
    '#description' => t('Specify the graph height in pixels. The Chart API will reject charts that are too tall.'),
  );
  $form['display']['quant_use_images'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use chart images'),
    '#default_value' => variable_get('quant_use_images', 1),
    '#description' => t('If selected, chart images will be used to display the data, otherwise tables will be used.'),
  );

  // Generate the color palette
  $palette = _quant_load_palette();
  $form['color'] = array(
    '#type' => 'fieldset',
    '#title' => t('Color settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#description' => t('Specify the colors that the charts will be rendered in.'),
  );
  for ($i = 0; $i < QUANT_PALETTE_AMOUNT; $i++) {
    $form['color']['quant_palette_color_' . $i] = array(
      '#type' => 'textfield',
      '#title' => t('Color') . ' #' . ($i + 1),
      '#default_value' => $palette[$i],
      '#field_prefix' => '#',
      '#size' => 10,
      '#maxlength' => 6,
    );
  }
  return system_settings_form($form);
}
function quant_admin_settings_validate(&$form, &$form_state) {

  // Check width
  if (!is_numeric($form_state['values']['quant_width']) || strlen($form_state['values']['quant_width']) > 4 || strlen($form_state['values']['quant_width']) < 2) {
    form_set_error('quant_width', t('The width must be a number that is between 2 and 4 digits'));
  }

  // Check height
  if (!is_numeric($form_state['values']['quant_height']) || strlen($form_state['values']['quant_height']) > 4 || strlen($form_state['values']['quant_height']) < 2) {
    form_set_error('quant_height', t('The height must be a number that is between 2 and 4 digits'));
  }

  // Iterate through colors
  $colors = array();

  // Store all colors in a single array
  for ($i = 0; $i < QUANT_PALETTE_AMOUNT; $i++) {
    $color = $form_state['values']['quant_palette_color_' . $i];

    // If color exists, make sure it's valid
    if ($color) {
      $colors[] = strtoupper($color);

      // Remove form value to avoid multiple color variables
      unset($form_state['values']['quant_palette_color_' . $i]);
    }
  }

  // Make sure we at least have one color
  if (empty($colors)) {
    form_set_error('color', t('You need to enter at least one color.'));
  }
  else {

    // Save colors in a single variable
    variable_set('quant_palette', $colors);
  }
}

Functions

Name	Description
quant_admin_settings	Provide admin settings form
quant_admin_settings_validate
quant_time_form	Provide a simple form to change time periods
quant_time_form_submit	Submit handler for quant_time_form()
quant_time_form_validate	Validate handler for quant_time_form()