admin.system.inc in Constant Contact 7.3

Main admin functions.

File

admin.system.inc

<?php

/**
 * @file
 * Main admin functions.
 */

/**
 * Displays the module intro page.
 */
function constant_contact_intro() {
  $info_filename = drupal_get_path('module', 'constant_contact') . '/' . 'constant_contact' . '.info';
  $module = drupal_parse_info_file($info_filename);
  $html = '';

  // Display a message about the webform CC module.
  if (module_exists('webform') and !module_exists('webform_constant_contact')) {
    $html = t('<p><span style="color:green; font-weight:bold; font-size:1em;">Did you know you can integrate webform with the constant contact module? - <a href="http://drupal.org/project/webform_constant_contact">To find out more click here</a></span></p>');
  }
  $html .= '<p>This is version ' . $module['version'] . ' of the Constant Contact module for Drupal.</p>';
  $html .= '<p>If you do not have a constant contact account <a target="_blank" href="@cc">Signup for a free 60-day trial</a>.</p>';
  $html .= '<p>Instructions for setting up the module can be found <a href="@instructions">here</a>.</p>';
  $html .= '<p>If you find any problems or need help see <a href="@help">here</a>.</p>';
  $params = array(
    '@instructions' => url('admin/help/constant_contact'),
    '@help' => 'http://drupal.org/project/issues/constant_contact?categories=All',
    '@cc' => CC_TRIAL_URL,
  );
  return t($html, $params);
}

/**
 * Displays the module settings page.
 */
function constant_contact_settings() {

  //user_roles()
  drupal_add_js(drupal_get_path('module', 'constant_contact') . '/constant_contact.js');
  $form = array();
  $lists = array();

  // if we have an object get the users contact lists
  $cc = constant_contact_create_object();
  if (is_object($cc)) {
    $lists = constant_contact_get_lists($cc);
  }

  // Registration page settings.
  $form['constant_contact']['form'] = array(
    '#type' => 'fieldset',
    '#title' => t('Register Page and Update User Page Settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => FALSE,
    '#description' => t('Customize register page and update user page settings, these settings also apply to the drupal admin interface add and edit user pages'),
  );
  $form['constant_contact']['form']['cc_register_page_method'] = array(
    '#type' => 'radios',
    '#title' => t('Subscribe Method'),
    '#description' => t('Choose to either display a simple checkbox or a list of your contact lists so the user can choose which lists they want to subscribe to'),
    '#default_value' => variable_get('cc_register_page_method', CC_REGISTER_PAGE_METHOD),
    '#options' => array(
      'none' => 'Disabled',
      'checkbox' => 'Checkbox - check a checkbox to subscribe',
      'lists' => 'List Selection - select one or more contact lists to subscribe',
    ),
  );
  $form['constant_contact']['form']['cc_default_opt_in'] = array(
    '#type' => 'checkbox',
    '#title' => t('Opt-in users by default?'),
    '#description' => t('This determines if the register page checkbox is checked by default or if using the "List Selection" method the user will have all lists selected by default, uncheck this box if you want users to have to manually subscribe'),
    '#default_value' => variable_get('cc_default_opt_in', CC_DEFAULT_OPT_IN),
  );
  if ($lists) {
    $form['constant_contact']['form']['cc_lists'] = array(
      '#type' => 'select',
      '#title' => t('Contact lists'),
      '#default_value' => variable_get('cc_lists', ''),
      '#options' => $lists,
      '#multiple' => TRUE,
      '#size' => 10,
      '#description' => t('If using the Checkbox subscribe method choose which contact lists the user will be automatically added to, alternatively if using the List selection method choose which lists will be shown to the user, if you dont select any lists here all lists will be used'),
    );
  }
  $form['constant_contact']['form']['cc_signup_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Signup Title Text'),
    '#description' => t("The title text displayed on the register page, if enabled"),
    '#default_value' => variable_get('cc_signup_title', CC_SIGNUP_TITLE),
    '#size' => 60,
  );
  $form['constant_contact']['form']['cc_signup_description'] = array(
    '#type' => 'textarea',
    '#title' => t('Signup Description Text'),
    '#description' => t("The description text displayed on the register page, if enabled"),
    '#default_value' => variable_get('cc_signup_description', CC_SIGNUP_DESCRIPTION),
    '#maxlength' => NULL,
    '#rows' => 3,
  );
  $form['constant_contact']['form']['cc_extra_field_mappings'] = array(
    '#type' => 'textarea',
    '#title' => t('Extra Field Mappings'),
    '#description' => t('Specify the mappings for any extra fields you want to send to constant contact. You should define these in the format <em>FirstName:ActualFieldname</em> and separate with a comma. You will only need to change the second value to match your form field names. If using with the Drupal profile module, this would typically be entered as <em>FirstName:profile_first_name</em>.'),
    '#default_value' => variable_get('cc_extra_field_mappings', ''),
    '#rows' => 6,
  );

  // Contact list settings.
  $form['constant_contact']['lists'] = array(
    '#type' => 'fieldset',
    '#title' => t('Contact List Settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => FALSE,
    '#description' => t('Contact list settings'),
  );
  $form['constant_contact']['lists']['cc_contact_list_sort_order'] = array(
    '#type' => 'select',
    '#title' => t('Sort contact lists by'),
    '#description' => t('You can change the way contact lists are sorted, Name sorts them alphabetically, id sorts them newest to oldest, Sort Order sorts them using the custom Order you have defined'),
    '#default_value' => variable_get('cc_contact_list_sort_order', CC_CONTACT_LIST_SORT_ORDER),
    '#options' => array(
      'SortOrder' => 'Sort Order',
      'id' => 'ID',
      'Name' => 'Name',
    ),
  );
  $form['constant_contact']['lists']['cc_list_selection_format'] = array(
    '#type' => 'radios',
    '#title' => t('List Selection Format'),
    '#default_value' => variable_get('cc_list_selection_format', CC_LIST_SELECTION_FORMAT),
    '#options' => array(
      'select' => 'Multi-Select',
      'checkbox' => 'Checkboxes',
    ),
    '#description' => t('You can change the format of the list selection to either checkboxes or a multi-select drop down, the default is a multi-select drop down.'),
  );

  // Global settings.
  $form['constant_contact']['other'] = array(
    '#type' => 'fieldset',
    '#title' => t('Global Settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => FALSE,
    '#description' => t('Global settings that apply to everywhere apart from the signup form blocks'),
  );
  $form['constant_contact']['other']['cc_sync_unsubscribed_users'] = array(
    '#type' => 'checkbox',
    '#title' => t('Synchronize unsubscribed users?'),
    '#description' => t('Checking this means the module will automatically synchronize users who have unsubscribed directly with the constant contact service with those users in your drupal database, this is necessary because people can unsubscribe from your mailing list through the constant contact website. This feature has only been tested with a small amount of users, use this option with extreme caution, if you have a large site consider running the drupal cron jobs more often to ensure it does not overload the server, likewise if you have a small site run the cron jobs less often to avoid checking for users with the API, alternatively disable this feature altogether and always use the Constant Contact website to get the latest subscribers data'),
    '#default_value' => variable_get('cc_sync_unsubscribed_users', CC_SYNC_UNSUBSCRIBED_USERS),
  );
  $form['constant_contact']['other']['cc_subscribe_format'] = array(
    '#type' => 'radios',
    '#title' => t('Default Email Format'),
    '#description' => t('You can choose the format of email for new subscribers, HTML or Text, if you select to show a selection to the user below it will ask them what format email they would like to receive and the option you choose here will be selected by default'),
    '#default_value' => variable_get('cc_subscribe_format', CC_SUBSCRIBE_FORMAT),
    '#options' => array(
      'HTML' => 'HTML',
      'Text' => 'Text',
    ),
  );
  $form['constant_contact']['other']['cc_show_format_choice'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show Email Format Selection'),
    '#description' => t('Should we show an email format selection to subscribers, if you check this box it will show a selection to the user allowing them to choose between HTML and Text email'),
    '#default_value' => variable_get('cc_show_format_choice', CC_SHOW_FORMAT_CHOICE),
  );
  $form['constant_contact']['other']['cc_lists_cache_expire'] = array(
    '#type' => 'select',
    '#title' => t('Contact lists expire after'),
    '#description' => t('This defines how long the contact lists are kept in the cache'),
    '#default_value' => variable_get('cc_lists_cache_expire', CC_CONTACT_LISTS_CACHE_EXPIRE),
    '#options' => array(
      3600 => '1 hour',
      3600 * 2 => '2 hours',
      3600 * 3 => '3 hours',
      3600 * 4 => '4 hours',
      3600 * 5 => '5 hours',
      3600 * 10 => '10 hours',
      3600 * 24 => '24 hours',
    ),
  );
  $form['constant_contact']['other']['cc_total_blocks_available'] = array(
    '#type' => 'textfield',
    '#title' => t('Total Blocks Available'),
    '#size' => 10,
    '#description' => t('This defines how many different signup form blocks you can create, these signup form blocks act independently of each other and each have their own settings'),
    '#default_value' => variable_get('cc_total_blocks_available', CC_BLOCK_COUNT),
  );
  $form['#redirect'] = 'admin/settings/constant_contact/intro';
  return system_settings_form($form);
}

/**
 * Submit handler for the module settings.
 */
function constant_contact_settings_submit($form, &$form_state) {
  drupal_set_message(t('Constant Contact module settings have been saved'));
}

/**
 * Form builder for the module setup form.
 */
function constant_contact_setup() {
  drupal_add_js(drupal_get_path('module', 'constant_contact') . '/constant_contact.js');
  $form = array();

  // Account settings.
  $form['constant_contact']['account'] = array(
    '#type' => 'fieldset',
    '#title' => t('Account Settings'),
    '#tree' => FALSE,
    '#description' => t('Change your constant contact account username and password'),
  );
  $form['constant_contact']['account']['cc_username'] = array(
    '#id' => 'cc_username',
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#description' => t("The Constant Contact Account Username"),
    '#default_value' => variable_get('cc_username', ''),
    '#size' => 60,
    '#required' => TRUE,
  );
  $form['constant_contact']['account']['cc_password'] = array(
    '#id' => 'cc_password',
    '#type' => 'password',
    '#title' => t('Password'),
    '#description' => t("The Constant Contact Account Password"),
    '#default_value' => variable_get('cc_password', ''),
    '#size' => 60,
    '#required' => TRUE,
  );
  $form['constant_contact']['account']['cc_path'] = array(
    '#id' => 'cc_path',
    '#type' => 'hidden',
    '#value' => drupal_get_path('module', 'constant_contact'),
  );
  $form['constant_contact']['account']['cc_auth'] = array(
    '#id' => 'cc_auth',
    '#type' => 'submit',
    '#value' => t('Check Account Details'),
  );
  $form['constant_contact']['account']['cc_auth_res'] = array(
    '#type' => 'markup',
    '#markup' => '<div class="cc_auth_res">&nbsp;</div>',
  );
  $form['#submit'][] = 'constant_contact_setup_submit';
  $form['#redirect'] = 'admin/config/services/constant_contact/settings';
  return system_settings_form($form);
}

/**
 * Submit handler for the module setup form.
 */
function constant_contact_setup_submit($form, &$form_state) {
  drupal_set_message(t('Constant Contact module settings have been saved'));
}

Functions

Name	Description
constant_contact_intro	Displays the module intro page.
constant_contact_settings	Displays the module settings page.
constant_contact_settings_submit	Submit handler for the module settings.
constant_contact_setup	Form builder for the module setup form.
constant_contact_setup_submit	Submit handler for the module setup form.