<?php
// $Id:

/**
 * @file
 * These are hooks related to image presets and actions.
 */
 
/**
 * @addtogroup hooks
 * @{
 */

/**
 * Define image actions.
 *
 * This hook enables modules to define image manipulation actions for use with
 * an image preset.
 *
 * @return
 *   An array of image actions. Each action has a key corresponding to the
 *   machine-readable action name. The action is an associative array that may
 *   contain the following key-value paris:
 *
 *   - "name": Required. The human-readable name of the action.
 *   - "description": Required. A brief description of the action.
 *   - "function": Required. The function to call to perform this action.
 *   - "form": The name of a function that will return a $form array providing
 *     a configuration form for this action.
 *   - "summary": The name of a theme function that will output a summary of
 *     this actions configuration.
 *   - "file": The name of an include file that the action can be found in
 *     relative to the implementing module's path.
 *   - "file path": The directory path in which the include file resides. If
 *     left empty this will default to the implementing module's directory.
 */
function hook_image_actions() {
  $actions = array();

  $actions['mymodule_resize'] = array(
    'name' => t('Resize'),
    'descritpion' => t('Resize an image to an exact set of dimensions, ignoring aspect ratio.'),
    'function' => 'mymodule_resize_image',
    'form' => 'mymodule_resize_form',
    'summary' => 'mymodule_resize_summary',
    'file' => 'mymodule.actions.inc',
  );

  return $actions;
}

/**
 * Respond to preset updating.
 *
 * This hook enables modules to take action when a preset is saved by, for
 * example, updating a module specific variable to reflect a change in the
 * presets name.
 *
 * @param $preset
 *   The preset being updated.
 * @return
 *   None.
 */
function hook_image_preset_save($preset) {
  // If a module defines an image preset and that preset is renamed by the user
  // the module should update any references to that preset.
  if (isset($preset['old_name'] && $preset['old_name'] == variable_get('mymodule_image_preset', '')) {
    variable_set('mymodule_image_preset', $preset['name']);
  }
}

/**
 * Respond to preset deletion.
 *
 * This hook enables modules to take action when a preset is being deleted by,
 * for example, replacing the preset being deleted with another one.
 *
 * @param $preset
 *   The preset being deleted.
 * @return
 *   None.
 */
function hook_image_preset_delete($preset) {
  // Administrators can choose an optional replacement preset when deleting.
  // Update the modules preset variable accordingly.
  if (isset($preset['old_name'] && $preset['old_name'] == variable_get('mymodule_image_preset', '')) {
    variable_set('mymodule_image_preset', $preset['name']);
  }
}

/**
 * Respond to preset flushing.
 *
 * This hook enables modules to take action when a preset is being flushed by,
 * for example, emptying any module specific caches that contain information
 * related to the preset. This hook is called whenever a preset is updated,
 * deleted, any action associated with the preset is update or deleted, or when
 * the user selects the preset flush option.
 *
 * @param $preset
 *   The preset being flushed.
 */
function hook_image_preset_flush($preset) {
  // Empty cached data that contains information about the preset.
  cache_clear_all('*', 'cache_mymodule', TRUE);
}
 /**
  * @} End of "addtogroup hooks".
  */