You are here

Home » API reference » ImageField 6.3

imagefield_widget.inc in ImageField 6.3

ImageField widget hooks and callbacks.

File

imagefield_widget.inc
View source 
<?php

/**
 * @file
 * ImageField widget hooks and callbacks.
 */

/**
 * Implementation of CCK's hook_widget_settings($op = 'form').
 */
function imagefield_widget_settings_form($widget) {
  $form = module_invoke('filefield', 'widget_settings', 'form', $widget);
  if ($form['file_extensions']['#default_value'] == 'txt') {
    $form['file_extensions']['#default_value'] = 'png gif jpg jpeg';
  }
  $form['max_resolution'] = array(
    '#type' => 'textfield',
    '#title' => t('Maximum dimensions for images'),
    '#default_value' => !empty($widget['max_resolution']) ? $widget['max_resolution'] : 0,
    '#size' => 15,
    '#maxlength' => 10,
    '#description' => t('The maximum allowed image size expressed as WIDTHxHEIGHT (e.g. 640x480). Set to 0 for no restriction. If a larger image is uploaded, it will be resized to reflect the given width and height.'),
    '#weight' => 2.1,
  );
  $form['min_resolution'] = array(
    '#type' => 'textfield',
    '#title' => t('Minimum dimensions for images'),
    '#default_value' => !empty($widget['min_resolution']) ? $widget['min_resolution'] : 0,
    '#size' => 15,
    '#maxlength' => 10,
    '#description' => t('The minimum allowed image size expressed as WIDTHxHEIGHT (e.g. 640x480). Set to 0 for no restriction. If an image that is smaller than these dimensions is uploaded it will be rejected.'),
    '#weight' => 2.2,
  );
  if (!module_exists('imageapi') || imageapi_default_toolkit() == 'imageapi_gd') {
    $form['max_resolution']['#description'] .= ' ' . t('Resizing images on upload will cause the loss of <a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format">EXIF data</a> in the image.');
  }
  $form['alt_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('ALT text settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 8,
  );
  $form['alt_settings']['custom_alt'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable custom alternate text'),
    '#default_value' => !empty($widget['custom_alt']) ? $widget['custom_alt'] : 0,
    '#description' => t('Enable user input alternate text for images.'),
  );
  $form['alt_settings']['alt'] = array(
    '#type' => 'textfield',
    '#title' => t('Default ALT text'),
    '#default_value' => !empty($widget['alt']) ? $widget['alt'] : '',
    '#description' => t('This value will be used for alternate text by default.'),
    '#suffix' => theme('token_help', array(
      'user',
    )),
  );
  $form['title_settings'] = array(
    '#type' => 'fieldset',
    '#title' => t('Title text settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 8,
  );
  $form['title_settings']['custom_title'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable custom title text'),
    '#default_value' => !empty($widget['custom_title']) ? $widget['custom_title'] : 0,
    '#description' => t('Enable user input title text for images.'),
  );
  $form['title_settings']['title_type'] = array(
    '#type' => 'select',
    '#title' => t('Input type'),
    '#options' => array(
      'textfield' => 'textfield',
      'textarea' => 'textarea',
    ),
    '#default_value' => !empty($widget['title_type']) ? $widget['title_type'] : 'textfield',
    '#description' => t('Choose type of field to be displayed to the user.'),
  );
  $form['title_settings']['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Default Title text'),
    '#default_value' => !empty($widget['title']) ? $widget['title'] : '',
    '#description' => t('This value will be used as the image title by default.'),
    '#suffix' => theme('token_help', array(
      'user',
    )),
  );

  // Default image settings.
  $form['default'] = array(
    '#type' => 'fieldset',
    '#title' => t('Default image'),
    '#element_validate' => array(
      '_imagefield_widget_settings_default_validate',
    ),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#weight' => 10,
  );

  // Present a thumbnail of the current default image.
  $form['default']['use_default_image'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use default image'),
    '#default_value' => $widget['use_default_image'],
    '#description' => t('When an image is not uploaded, show a default image on display.'),
  );
  if (!empty($widget['default_image'])) {
    $form['default']['default_image_thumbnail'] = array(
      '#type' => 'markup',
      '#value' => theme('imagefield_image', $widget['default_image'], '', '', array(
        'width' => '150',
      ), FALSE),
    );
  }
  $form['default']['default_image_upload'] = array(
    '#type' => 'file',
    '#title' => t('Upload image'),
    '#description' => t('Choose a image that will be used as default.'),
  );

  // We set this value on 'validate' so we can get CCK to add it
  // as a standard field setting.
  $form['default_image'] = array(
    '#type' => 'value',
    '#value' => $widget['default_image'],
  );
  return $form;
}

/**
 * Element specific validation for imagefield default value.
 *
 * Validated in a separate function from imagefield_field() to get access
 * to the $form_state variable.
 */
function _imagefield_widget_settings_default_validate($element, &$form_state) {

  // Skip this validation if there isn't a default file uploaded at all or if
  // validation has already failed because of another error.
  if (!is_uploaded_file($_FILES['files']['tmp_name']['default_image_upload']) || form_set_error()) {
    return;
  }

  // Verify the destination exists.
  $destination = file_directory_path() . '/imagefield_default_images';
  if (!field_file_check_directory($destination, FILE_CREATE_DIRECTORY)) {
    form_set_error('default_image', t('The default image could not be uploaded. The destination %destination does not exist or is not writable by the server.', array(
      '%destination' => dirname($destination),
    )));
    return;
  }
  $validators = array(
    'file_validate_is_image' => array(),
  );

  // We save the upload here because we can't know the correct path until the file is saved.
  if (!($file = file_save_upload('default_image_upload', $validators, $destination))) {

    // No upload to save we hope... or file_save_upload() reported an error on its own.
    return;
  }

  // Remove the old default image if any.
  $old_default = $form_state['values']['default_image'];
  if (!empty($old_default['fid'])) {

    // Set a flag to not count this instance in hook_file_references().
    $old_default['imagefield_type_name'] = $form_state['values']['type_name'];
    field_file_delete($old_default);
  }

  // Make the file permanent and store it in the form.
  file_set_status($file, FILE_STATUS_PERMANENT);
  $file->timestamp = time();
  $form_state['values']['default_image'] = (array) $file;
}

/**
 * Implementation of CCK's hook_widget_settings($op = 'validate').
 */
function imagefield_widget_settings_validate($widget) {

  // Check that only web images are specified in the callback.
  $extensions = array_filter(explode(' ', $widget['file_extensions']));
  $web_extensions = array(
    'jpg',
    'jpeg',
    'gif',
    'png',
  );
  if (count(array_diff($extensions, $web_extensions))) {
    form_set_error('file_extensions', t('Only web-standard images (jpg, gif, and png) are supported through the image widget. If needing to upload other types of images, change the widget to use a standard file upload.'));
  }

  // Check that set resolutions are valid.
  foreach (array(
    'min_resolution',
    'max_resolution',
  ) as $resolution) {
    if (!empty($widget[$resolution]) && !preg_match('/^[0-9]+x[0-9]+$/', $widget[$resolution])) {
      form_set_error($resolution, t('Please specify a resolution in the format WIDTHxHEIGHT (e.g. 640x480).'));
    }
  }
}

/**
 * Implementation of CCK's hook_widget_settings($op = 'save').
 */
function imagefield_widget_settings_save($widget) {
  $filefield_settings = module_invoke('filefield', 'widget_settings', 'save', $widget);
  return array_merge($filefield_settings, array(
    'max_resolution',
    'min_resolution',
    'alt',
    'custom_alt',
    'title',
    'custom_title',
    'title_type',
    'default_image',
    'use_default_image',
  ));
}

/**
 * Element #value_callback function.
 */
function imagefield_widget_value($element, $edit = FALSE) {
  $item = filefield_widget_value($element, $edit);
  if ($edit) {
    $item['alt'] = isset($edit['alt']) ? $edit['alt'] : '';
    $item['title'] = isset($edit['title']) ? $edit['title'] : '';
  }
  else {
    $item['alt'] = '';
    $item['title'] = '';
  }
  return $item;
}

/**
 * Element #process callback function.
 */
function imagefield_widget_process($element, $edit, &$form_state, $form) {
  $file = $element['#value'];
  $field = content_fields($element['#field_name'], $element['#type_name']);
  $element['#theme'] = 'imagefield_widget_item';
  if (isset($element['preview']) && $element['#value']['fid'] != 0) {
    $element['preview']['#value'] = theme('imagefield_widget_preview', $element['#value']);
  }

  // Check if using the default alt text and replace tokens.
  $default_alt = !$field['widget']['custom_alt'] || empty($file['status']) && empty($file['data']['alt']);
  if ($default_alt && function_exists('token_replace')) {
    $field['widget']['alt'] = empty($field['widget']['alt']) ? '' : token_replace($field['widget']['alt'], 'user', $GLOBALS['user']);
  }
  $element['data']['alt'] = array(
    '#title' => t('Alternate Text'),
    '#type' => $field['widget']['custom_alt'] ? 'textfield' : 'value',
    '#default_value' => $default_alt ? $field['widget']['alt'] : $file['data']['alt'],
    '#description' => t('This text will be used by screen readers, search engines, or when the image cannot be loaded.'),
    '#maxlength' => variable_get('imagefield_alt_length', 80),
    // See http://www.gawds.org/show.php?contentid=28.
    '#attributes' => array(
      'class' => 'imagefield-text',
    ),
  );

  // #value must be hard-coded if #type = 'value'.
  if ($default_alt) {
    $element['data']['alt']['#value'] = $field['widget']['alt'];
  }

  // Check if using the default title and replace tokens.
  $default_title = !$field['widget']['custom_title'] || empty($file['status']) && empty($file['data']['title']);
  if ($default_title && function_exists('token_replace')) {
    $field['widget']['title'] = empty($field['widget']['title']) ? '' : token_replace($field['widget']['title'], 'user', $GLOBALS['user']);
  }

  // If the custom title is enabled, input type defaults to textfield.
  if (!empty($field['widget']['custom_title'])) {
    $title_type = !empty($field['widget']['title_type']) ? $field['widget']['title_type'] : 'textfield';
  }
  else {
    $title_type = 'value';
  }
  $element['data']['title'] = array(
    '#type' => $title_type,
    '#title' => t('Title'),
    '#default_value' => $default_title ? $field['widget']['title'] : $file['data']['title'],
    '#description' => t('The title is used as a tool tip when the user hovers the mouse over the image.'),
    '#maxlength' => variable_get('imagefield_title_length', 500),
    '#attributes' => array(
      'class' => 'imagefield-text',
    ),
  );

  // #value must be hard-coded if #type = 'value'.
  if ($default_title) {
    $element['data']['title']['#value'] = $field['widget']['title'];
  }
  return $element;
}

/**
 * FormAPI theme function. Theme the output of an image field.
 */
function theme_imagefield_widget($element) {
  drupal_add_css(drupal_get_path('module', 'imagefield') . '/imagefield.css');
  $element['#id'] .= '-upload';

  // Link the label to the upload field.
  return theme('form_element', $element, $element['#children']);
}

Functions

Namesort descending Description
imagefield_widget_process Element #process callback function.
imagefield_widget_settings_form Implementation of CCK's hook_widget_settings($op = 'form').
imagefield_widget_settings_save Implementation of CCK's hook_widget_settings($op = 'save').
imagefield_widget_settings_validate Implementation of CCK's hook_widget_settings($op = 'validate').
imagefield_widget_value Element #value_callback function.
theme_imagefield_widget FormAPI theme function. Theme the output of an image field.
_imagefield_widget_settings_default_validate Element specific validation for imagefield default value.