referers.inc in Visitors 8

Referers form for visitors module.

File

forms/referers.inc

<?php

/**
 * @file
 * Referers form for visitors module.
 */

/**
 * Referer type constants.
 */
define('REFERER_TYPE_INTERNAL_PAGES', 1);
define('REFERER_TYPE_EXTERNAL_PAGES', 2);
define('REFERER_TYPE_ALL_PAGES', 3);

/**
 * Set to session info default values for visitors referer type.
 */
function visitors_set_session_referer_type() {
  if (!isset($_SESSION['referer_type'])) {
    $_SESSION['referer_type'] = REFERER_TYPE_EXTERNAL_PAGES;
  }
}

/**
 * Renders HTML code for referers form.
 *
 * @return
 *   string the rendered html.
 */
function visitors_referers() {
  $form = drupal_get_form('visitors_referers_form');
  return drupal_render($form);
}

/**
 * Referers form data.
 */
function visitors_referers_form($form_state) {
  visitors_set_session_date_range();
  visitors_set_session_referer_type();
  $form = visitors_date_filter_form_block();
  $form['visitors_referer'] = array(
    '#type' => 'fieldset',
    '#title' => t('Referers type filter'),
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
    '#description' => t('Choose referers type'),
  );
  $form['visitors_referer']['referer_type'] = array(
    '#type' => 'select',
    '#title' => 'Referer type',
    '#default_value' => $_SESSION['referer_type'],
    '#options' => array(
      REFERER_TYPE_INTERNAL_PAGES => t('Internal pages'),
      REFERER_TYPE_EXTERNAL_PAGES => t('External pages'),
      REFERER_TYPE_ALL_PAGES => t('All pages'),
    ),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Visitors referers form values validation.
 */
function visitors_referers_form_validate($form, &$form_state) {
  visitors_date_filter_form_validate($form, $form_state);
}

/**
 * Submit values from referers form write to session info.
 */
function visitors_referers_form_submit($form, &$form_state) {
  visitors_date_filter_form_submit($form, $form_state);
  $_SESSION['referer_type'] = $form_state['values']['referer_type'];
}

/**
 * Build sql query from referer type value.
 *
 * @return string sql query.
 */
function visitors_referers_condition(&$query) {
  visitors_set_session_referer_type();
  switch ($_SESSION['referer_type']) {
    case REFERER_TYPE_INTERNAL_PAGES:
      $query
        ->condition('visitors_referer', sprintf('%%%s%%', $_SERVER['HTTP_HOST']), 'LIKE');
      $query
        ->condition('visitors_referer', '', '<>');
      break;
    case REFERER_TYPE_EXTERNAL_PAGES:
      $query
        ->condition('visitors_referer', sprintf('%%%s%%', $_SERVER['HTTP_HOST']), 'NOT LIKE');
      break;
    default:
      break;
  }
  return $query;
}

Functions

Name	Description
visitors_referers	Renders HTML code for referers form.
visitors_referers_condition	Build sql query from referer type value.
visitors_referers_form	Referers form data.
visitors_referers_form_submit	Submit values from referers form write to session info.
visitors_referers_form_validate	Visitors referers form values validation.
visitors_set_session_referer_type	Set to session info default values for visitors referer type.

Constants

Name	Description
REFERER_TYPE_ALL_PAGES
REFERER_TYPE_EXTERNAL_PAGES
REFERER_TYPE_INTERNAL_PAGES	Referer type constants.