Contributions API

imagecache.module

Version

1.68.2.7 (checked in on 2008/06/20 at 00:21:42 by drewish)

Description

Dynamic image resizer and image cacher.

Imagecache allows you to setup presets for image processing. If an ImageCache derivative doesn't exist the web server's rewrite rules will pass the request to Drupal which in turn hands it off to imagecache to dynamically generate the file.

To view a derivative image you request a special url containing 'imagecache/<presetname>/path/to/file.ext.

Presets can be managed at http://example.com/admin/build/imagecache.

To view a derivative image you request a special url containing 'imagecache/<presetname>/path/to/file.ext.

If you had a preset names 'thumbnail' and you wanted to see the thumbnail version of http://example.com/files/path/to/myimage.jpg you would use http://example.com/files/imagecache/thumbnail/path/to/myimage.jpg

ImageCache provides formatters for CCK Imagefields and is leveraged by several other modules. ImageCache also relies heavily on ImageAPI for it's image processing. If there are errors with actual image processing look to ImageAPI first.

@todo: add watermarking capabilities.

Functions

Name	Description
imagecache_action
imagecache_action_definition
imagecache_action_definitions	Pull in actions exposed by other modules using hook_imagecache_actions().
imagecache_action_delete
imagecache_action_save
imagecache_build_derivative	build an image cache derivative
imagecache_cache	callback for handling public files imagecache requests.
imagecache_cache_private	callback for handling private files imagecache requests
imagecache_create_path	Return a file system location that points to the location of a derivative of the original image at @p $path, transformed with the given @p $preset. Keep in mind that the image might not yet exist and won't be created.
imagecache_create_url	Return a URL that points to the location of a derivative of the original image at @p $path, transformed with the given @p $preset.
imagecache_field_formatter	Implementation of hook_field_formatter().
imagecache_field_formatter_info	Implementation of hook_field_formatter_info().
imagecache_imagecache_actions	Implementation of hook_imagecache_actions.
imagecache_imagefield_file
imagecache_image_flush	Clear cached versions of a specific file in all presets.
imagecache_menu	Implementation of hook_menu().
imagecache_perm	Implementation of hook_perm().
imagecache_preset	Load a preset by preset_id.
imagecache_presets	Get an array of all presets and their settings.
imagecache_preset_actions
imagecache_preset_by_name
imagecache_preset_delete
imagecache_preset_flush	Flush cached media for a preset.
imagecache_preset_save	Save an ImageCache preset.
imagecache_resize_form
imagecache_resize_image	********************************************************************************** ImageCache action implementation example in module.
imagecache_transfer
theme_imagecache
theme_imagecache_resize
_imagecache_apply_action
_imagecache_cache	handle request validation and responses to imagecache requests.
_imagecache_cache_set_cache_headers	Set file headers that handle "If-Modified-Since" correctly for the given fileinfo. Most code has been taken from drupal_page_cache_header().
_imagecache_definitions_sort
_imagecache_filter	Filter key word values such as 'top', 'right', 'center', and also percentages. All returned values are in pixels relative to the passed in height and width.
_imagecache_keyword_filter	Accept a keyword (center, top, left, etc) and return it as an offset in pixels.
_imagecache_percent_filter	Accept a percentage and return it in pixels.
_imagecache_recursive_delete	Recursively delete all files and folders in the specified filepath, then delete the containing folder.
_imagecache_strip_file_directory	Remove a possible leading file directory path from the given path.