splashify.admin.what.inc in Splashify 6

The admin "What" tab.

Admin functionality that determines what should show up as the splash page.

File

admin/splashify.admin.what.inc

<?php

/**
 * @file
 * The admin "What" tab.
 *
 * Admin functionality that determines what should show up as the splash
 * page.
 */

/**
 * "What" settings tab.
 */
function splashify_admin_what_form(&$form_state) {
  $form = array();
  $form['description'] = array(
    '#markup' => '<p>' . t('What should show up as the splash page?') . '</p>',
  );
  $form['desktop'] = array(
    '#type' => 'fieldset',
    '#title' => t('Desktop Settings'),
  );
  $form['desktop']['splashify_what_desktop_mode'] = array(
    '#type' => 'select',
    '#title' => t('Splash Mode'),
    '#options' => array(
      'random' => t('Pick random path or URL from the list'),
      'sequence' => t('Pick next path or URL from the list'),
      'template' => t('Display entered text in the site template'),
      'fullscreen' => t('Display entered text/HTML full screen'),
    ),
    '#default_value' => variable_get('splashify_what_desktop_mode', 'random'),
    '#description' => t('Determines how the content field below will be used with the splash page.'),
    '#ajax' => array(
      'callback' => 'splashify_ajax_what_desktop_mode_callback',
      'wrapper' => 'what-mode-desktop-value',
      'method' => 'replace',
      'effect' => 'fade',
    ),
  );

  // Set a variable that is either defined by the selection from the ajax
  // dropdown menu, or a previously saved value.
  if (isset($form_state['values']['splashify_what_desktop_mode'])) {
    $what_desktop_mode_set = $form_state['values']['splashify_what_desktop_mode'];
  }
  else {
    $what_desktop_mode_set = variable_get('splashify_what_desktop_mode', '');
  }
  $splashify_what_desktop_content = variable_get('splashify_what_desktop_content', '');
  $splashify_what_desktop_content_format = variable_get('splashify_what_desktop_content_format', 1);
  $form['desktop']['mode_value']['begin'] = array(
    '#markup' => '<div id="what-mode-desktop-value">',
  );

  // If they specified the template or fullscreen option, we want to hide the
  // window size text field.
  if ($what_desktop_mode_set == 'template' || $what_desktop_mode_set == 'fullscreen') {

    // Display a format field.
    $form['desktop']['mode_value']['splashify_what_desktop_content'] = array(
      '#type' => 'textarea',
      '#title' => t('Content'),
      '#default_value' => $splashify_what_desktop_content ? $splashify_what_desktop_content : '',
      '#description' => t('Enter the HTML you want to use on the page.'),
    );
    $form['desktop']['mode_value']['filter'] = filter_form($splashify_what_desktop_content_format);

    // If the template mode is selected, allow them to set a page title value.
    if ($what_desktop_mode_set == 'template') {
      $form['desktop']['mode_value']['splashify_what_desktop_pagetitle'] = array(
        '#type' => 'textfield',
        '#title' => t('Page Title'),
        '#default_value' => variable_get('splashify_what_desktop_pagetitle', ''),
      );
    }
  }
  else {

    // If this value is an array, the mode was changed and we want to empty
    // out the value.
    if (is_array($splashify_what_desktop_content)) {
      $splashify_what_desktop_content = '';
    }

    // Display a textarea field.
    $form['desktop']['mode_value']['splashify_what_desktop_content'] = array(
      '#type' => 'textarea',
      '#title' => t('Paths or Url Values'),
      '#default_value' => $splashify_what_desktop_content,
      '#description' => t('Enter the site paths or URLs (one on each line) to use. You can use either the drupal source path, or the alias. <br />To open a non-Drupal path, use an absolute URL, i.e. http://example.com/splash.html'),
    );
  }
  $form['desktop']['mode_value']['end'] = array(
    '#markup' => '</div>',
  );

  /*
   * Mobile settings.
   */
  $form['mobile'] = array(
    '#type' => 'fieldset',
    '#title' => t('Mobile Settings'),
  );

  // If the mobile splash is enabled, display the mobile options.
  if (variable_get('splashify_when_mobile', 0) == 1) {
    $form['mobile']['splashify_what_mobile_mode'] = array(
      '#type' => 'select',
      '#title' => t('Splash Mode'),
      '#options' => array(
        'random' => t('Pick random path or URL from the list'),
        'sequence' => t('Pick next path or URL from the list'),
        'template' => t('Display entered text in the site template'),
        'fullscreen' => t('Display entered text/HTML full screen'),
      ),
      '#default_value' => variable_get('splashify_what_mobile_mode', 'random'),
      '#description' => t('Determines how the content field below will be used with the splash page.'),
      '#ajax' => array(
        'callback' => 'splashify_ajax_what_mobile_mode_callback',
        'wrapper' => 'what-mode-mobile-value',
        'method' => 'replace',
        'effect' => 'fade',
      ),
    );

    // Set a variable that is either defined by the selection from the ajax
    // dropdown menu, or a previously saved value.
    if (isset($form_state['values']['splashify_what_mobile_mode'])) {
      $what_mobile_mode_set = $form_state['values']['splashify_what_mobile_mode'];
    }
    else {
      $what_mobile_mode_set = variable_get('splashify_what_mobile_mode', '');
    }
    $splashify_what_mobile_content = variable_get('splashify_what_mobile_content', '');
    $splashify_what_mobile_content_format = variable_get('splashify_what_mobile_content_format', 1);
    $form['mobile']['mode_value']['begin'] = array(
      '#markup' => '<div id="what-mode-mobile-value">',
    );

    // If they specified the template or fullscreen option, we want to hide the
    // window size text field.
    if ($what_mobile_mode_set == 'template' || $what_mobile_mode_set == 'fullscreen') {
      $form['mobile']['mode_value']['splashify_what_mobile_content'] = array(
        '#type' => 'textarea',
        '#title' => t('Content'),
        '#default_value' => $splashify_what_mobile_content ? $splashify_what_mobile_content : '',
        '#description' => t('Text to show or paths/URLs (one on each line) to use.  To open a non-Drupal path, use an absolute URL, i.e. http://example.com/splash.html'),
      );
      $form['mobile']['mode_value']['splashify_what_mobile_content_filter'] = filter_form($splashify_what_mobile_content_format, NULL, array(
        'splashify_what_mobile_content_filter',
      ));

      // If the template mode is selected, allow them to set a page title value.
      if ($what_mobile_mode_set == 'template') {
        $form['mobile']['mode_value']['splashify_what_mobile_pagetitle'] = array(
          '#type' => 'textfield',
          '#title' => t('Page Title'),
          '#default_value' => variable_get('splashify_what_mobile_pagetitle', ''),
        );
      }
    }
    else {

      // If this value is an array, the mode was changed and we want to empty
      // out the value.
      if (is_array($splashify_what_mobile_content)) {
        $splashify_what_mobile_content = '';
      }

      // Display a textarea field.
      $form['mobile']['mode_value']['splashify_what_mobile_content'] = array(
        '#type' => 'textarea',
        '#title' => t('Paths or Url Values'),
        '#default_value' => $splashify_what_mobile_content,
        '#description' => t('Enter the site paths or URLs (one on each line) to use. You can use either the drupal source path, or the alias. <br />To open a non-Drupal path, use an absolute URL, i.e. http://example.com/splash.html'),
      );
    }
    $form['mobile']['mode_value']['end'] = array(
      '#markup' => '</div>',
    );
  }
  else {
    $form['mobile']['splashify_what_mobile_mode'] = array(
      '#markup' => '<p>' . t('In order to specify mobile options, you need to enable the "When: Enable Unique Mobile Splash" option.') . '</p>',
    );
  }
  $form['#validate'][] = 'splashify_admin_what_form_validate';
  $form['#submit'][] = 'splashify_admin_what_form_submit';
  return system_settings_form($form);
}

/**
 * Implements form validation handler.
 */
function splashify_admin_what_form_validate($form, &$form_state) {

  // If they entered paths, make sure the path values are valid.
  $desktop_mode = $form_state['values']['splashify_what_desktop_mode'];
  if ($desktop_mode == 'random' || $desktop_mode == 'sequence') {
    splashify_what_paths_check('splashify_what_desktop_content', $form_state['values']['splashify_what_desktop_content']);
  }
  if (isset($form_state['values']['splashify_what_mobile_mode'])) {
    $mobile_mode = $form_state['values']['splashify_what_mobile_mode'];
    if ($mobile_mode == 'random' || $mobile_mode == 'sequence') {
      splashify_what_paths_check('splashify_what_mobile_content', $form_state['values']['splashify_what_mobile_content']);
    }
  }
}

/**
 * Implements form submit handler.
 */
function splashify_admin_what_form_submit($form, &$form_state) {

  // Clear out the title value if we aren't using the template option.
  if ($form_state['values']['splashify_what_desktop_mode'] != 'template') {
    variable_set('splashify_what_desktop_pagetitle', '');
  }
  if ($form_state['values']['splashify_what_mobile_mode'] != 'template') {
    variable_set('splashify_what_mobile_pagetitle', '');
  }
  if ($form_state['values']['format']) {
    variable_set('splashify_what_desktop_content_format', $form_state['values']['format']);
  }
  if ($form_state['values']['splashify_what_mobile_content_filter']) {
    variable_set('splashify_what_mobile_content_format', $form_state['values']['splashify_what_mobile_content_filter']);
  }
}

/**
 * Ajax callback for the desktop mode dropdown.
 *
 * The $form array element that is returned is the updated field that should
 * be displayed.
 */
function splashify_ajax_what_desktop_mode_callback($form, &$form_state) {
  return $form['desktop']['mode_value'];
}

/**
 * Ajax callback for the mobile mode dropdown.
 *
 * The $form array element that is returned is the updated field that should
 * be displayed.
 */
function splashify_ajax_what_mobile_mode_callback($form, &$form_state) {
  return $form['mobile']['mode_value'];
}

/**
 * Validate the what:paths field.
 *
 * We put this in a function so it can handle both the desktop and mobile
 * settings. This assumes that each path in $paths is separated by a new line
 * character. We also assume $paths cannot be blank.
 */
function splashify_what_paths_check($field, $paths) {
  if (empty($paths)) {
    form_set_error($field, t('You must enter at least one path.'));
    return;
  }

  // Make sure each path is valid.
  $what_paths = preg_split('/[\\n\\r]+/', $paths);
  $errors = array();
  foreach ($what_paths as $path) {

    // If this path is an alias, we know this is a valid path.
    if (drupal_lookup_path('source', $path)) {
      continue;
    }

    // If this path is a source url, we know this is a valid path.
    if (drupal_lookup_path('alias', $path)) {
      continue;
    }

    // Now check if this is a url value.
    $scheme = parse_url($path, PHP_URL_SCHEME);
    if ($scheme == 'http' || $scheme == 'https') {
      continue;
    }

    // Finally, check for unaliased internal paths, like "node/4"
    if (menu_valid_path(array(
      'link_path' => $path,
    ))) {
      continue;
    }

    // This path is not an alias or the source url.
    $errors[] .= t('The path "@path" is not valid.', array(
      '@path' => $path,
    ));
  }

  // Since there could be multiple errors for this one field, we want to
  // break each error into a separate line.
  if (count($errors) > 0) {
    form_set_error($field, implode('<br />', $errors));
  }
}

Functions

Name	Description
splashify_admin_what_form	"What" settings tab.
splashify_admin_what_form_submit	Implements form submit handler.
splashify_admin_what_form_validate	Implements form validation handler.
splashify_ajax_what_desktop_mode_callback	Ajax callback for the desktop mode dropdown.
splashify_ajax_what_mobile_mode_callback	Ajax callback for the mobile mode dropdown.
splashify_what_paths_check	Validate the what:paths field.