upload.form.inc in Dynamic Background 7.2

The functions here is used to create an new form element (background_upload_form), which can be used to upload images. It also gives the possibility to flag a image for deletion or active background image.

File

includes/upload.form.inc

<?php

/**
 * @file
 * The functions here is used to create an new form element
 * (background_upload_form), which can be used to upload images. It also gives
 * the possibility to flag a image for deletion or active background image.
 */

/**
 * Implements hook_elements().
 */
function dynamic_background_element_info() {
  $types = array();
  $types['background_upload_form'] = array(
    '#input' => TRUE,
    '#theme' => array(
      'background_upload_form',
    ),
    '#theme_wrappers' => array(
      'form_element',
    ),
    '#process' => array(
      'dynamic_background_upload_form_process',
    ),
    '#element_validate' => array(
      'dynamic_background_upload_form_validate',
    ),
  );
  return $types;
}

/**
 * Theming function for background_upload_form.
 *
 */
function theme_background_upload_form($element) {
  $output = '';
  $output .= '<div class="background-upload-form">';
  $output .= drupal_render_children($element['element']);
  $output .= '</div>';
  return $output;
}

/**
 * Implements hook_form_process(). Handles the background_upload_form
 * element processing and building.
 *
 */
function dynamic_background_upload_form_process($element, &$form_state, $form) {
  $element['#tree'] = TRUE;

  // Merge the default values.
  if (!isset($element['#value'])) {
    $element['#value'] = $element['#default_value'];
  }
  else {
    if (is_array($element['#default_value'])) {
      $element['#value'] = array_merge($element['#value'], $element['#default_value']);
    }
  }

  // If image is already uploaded.
  if (!empty($element['#value']['picture'])) {

    // Work out the thumbnail style to use.
    $settings = variable_get('dynamic_background_image_style', array());

    // Create image preview thumbnail.
    $image = array(
      'style_name' => isset($settings['thumbnail_style']) && $settings['thumbnail_style'] ? $settings['thumbnail_style'] : 'thumbnail',
      'path' => $element['#value']['picture'],
      'alt' => basename($element['#value']['picture']),
      'title' => basename($element['#value']['picture']),
    );
    $picture = theme('image_style', $image);
    $element['current_picture'] = array(
      '#markup' => $picture,
    );

    // Checkbox to indicate if this image should be used as background image.
    $element['picture_use'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use picture as background'),
      '#default_value' => isset($element['#value']['picture_use']) ? $element['#value']['picture_use'] : '',
      '#prefix' => '<div class="picture-use">',
      '#suffix' => '</div>',
    );

    // Replace the title with something more accurate if the main Dynamic
    // Background selection is the default option. By default the main module's
    // configuration is last, which would be implied by an empty 'weight'
    // array, otherwise it would have to be the last item in the array.
    $weights = variable_get('dynamic_background_weight', array());
    if (empty($weights) || ($weight = array_pop($weights)) && isset($weight['name']) && $weight['name'] == 'dynamic_background') {
      $element['picture_use']['#title'] = t("Use picture as the site's default background.");
    }

    // Checkbox to control deletion of the image.
    $element['picture_delete'] = array(
      '#type' => 'checkbox',
      '#title' => t('Delete picture'),
      '#default_value' => isset($element['#value']['picture_delete']) ? $element['#value']['picture_delete'] : '',
    );

    // Image path used by the administration UI.
    $element['picture'] = array(
      '#type' => 'hidden',
      '#default_value' => isset($element['#value']['picture']) ? $element['#value']['picture'] : '',
    );

    // Image file id, used when the file is deleted.
    $element['fid'] = array(
      '#type' => 'hidden',
      '#default_value' => isset($element['#value']['fid']) ? $element['#value']['fid'] : '',
    );
  }
  else {

    // No image uploaded, so display image upload field.
    $element['picture'] = array(
      '#type' => 'file',
      '#description' => t('Select image file to upload'),
    );
  }

  // Load styling and js.
  drupal_add_css(drupal_get_path('module', 'dynamic_background') . '/css/dynamic_background.admin.css');
  drupal_add_js(drupal_get_path('module', 'dynamic_background') . '/js/dynamic_background.js');
  return $element;
}

/**
 * Validation of the background_upload_form element. It have to return the
 * $form.
 *
 */
function dynamic_background_upload_form_validate($element, &$form_state) {
  return $element;
}

Functions

Name	Description
dynamic_background_element_info	Implements hook_elements().
dynamic_background_upload_form_process	Implements hook_form_process(). Handles the background_upload_form element processing and building.
dynamic_background_upload_form_validate	Validation of the background_upload_form element. It have to return the $form.
theme_background_upload_form	Theming function for background_upload_form.