[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/imagecache/ -> imagecache.module (summary)

(no description)

File Size: 1360 lines (45 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 54 functions

  imagecache_perm()
  imagecache_menu()
  _imagecache_menu_access_public_files()
  imagecache_form_system_modules_alter()
  imagecache_form_system_file_system_settings_alter()
  imagecache_system_file_system_submit()
  imagecache_theme()
  imagecache_imagecache_actions()
  imagecache_action_definitions()
  _imagecache_definitions_sort()
  imagecache_action_definition()
  imagecache_create_url()
  imagecache_create_path()
  _imagecache_strip_file_directory()
  imagecache_cache()
  imagecache_cache_private()
  _imagecache_cache()
  _imagecache_apply_action()
  imagecache_transfer()
  _imagecache_cache_set_cache_headers()
  imagecache_build_derivative()
  imagecache_user()
  imagecache_file_delete()
  imagecache_field_formatter_info()
  theme_imagecache_formatter_default()
  theme_imagecache_formatter_linked()
  theme_imagecache_formatter_imagelink()
  theme_imagecache_formatter_path()
  theme_imagecache_formatter_url()
  _imagecache_percent_filter()
  _imagecache_keyword_filter()
  _imagecache_recursive_delete()
  theme_imagecache()
  theme_imagecache_imagelink()
  imagecache_add_js()
  imagecache_presets()
  imagecache_preset()
  imagecache_preset_by_name()
  imagecache_preset_save()
  imagecache_preset_delete()
  imagecache_preset_actions()
  imagecache_preset_flush()
  imagecache_image_flush()
  imagecache_action()
  imagecache_action_load()
  imagecache_action_save()
  imagecache_action_delete()
  imagecache_action_info()
  imagecache_flush_action()
  imagecache_generate_all_action()
  imagecache_generate_action()
  imagecache_generate_action_form()
  imagecache_generate_image()
  imagecache_get_images_in_node()

Functions
Functions that are not part of a class:

imagecache_perm()   X-Ref
Implementation of hook_perm().


imagecache_menu()   X-Ref
Implementation of hook_menu().


_imagecache_menu_access_public_files()   X-Ref
Menu access callback for public file transfers.


imagecache_form_system_modules_alter(&$form, $form_state)   X-Ref
Implementation of hook_form_FORM_ID_alter.

Clear imagecache presets cache on admin/build/modules form.

imagecache_form_system_file_system_settings_alter(&$form, &$form_state)   X-Ref
Implementation of hook_form_FORM_ID_alter.

The file system form is modified to include an extra submit handler, so
that imagecache can rebuild the menu after the filesystem path is changed.

imagecache_system_file_system_submit($form, &$form_state)   X-Ref
Rebuild menus to ensure we've got the right files directory callback.


imagecache_theme()   X-Ref
Implementation of hook_theme().


imagecache_imagecache_actions()   X-Ref
Implementation of hook_imagecache_actions.

return: array

imagecache_action_definitions($reset = FALSE)   X-Ref
Pull in actions exposed by other modules using hook_imagecache_actions().

param: $reset
return:

_imagecache_definitions_sort($a, $b)   X-Ref
No description

imagecache_action_definition($action)   X-Ref
No description

imagecache_create_url($presetname, $filepath, $bypass_browser_cache = FALSE, $absolute = TRUE)   X-Ref
Return a URL that points to the location of a derivative of the original
image transformed with the given preset.

Special care is taken to make this work with the possible combinations of
Clean URLs and public/private downloads. For example, when Clean URLs are not
available an URL with query should be returned, like
http://example.com/?q=files/imagecache/foo.jpg, so that ImageCache is able
intercept the request for this file.

This code began similarly to Drupal core's function file_create_url(), but
handles the case of Clean URLs and public downloads differently however.
It also implements hook_file_url_alter() which was added to Drupal 7 and
backported to PressFlow 6.x.

param: $presetname
param: $filepath
param: $bypass_browser_cache
param: $absolute

imagecache_create_path($presetname, $path)   X-Ref
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_strip_file_directory($path)   X-Ref
Remove a possible leading file directory path from the given path.


imagecache_cache()   X-Ref
callback for handling public files imagecache requests.


imagecache_cache_private()   X-Ref
callback for handling private files imagecache requests


_imagecache_cache($presetname, $path)   X-Ref
Handle request validation and responses to ImageCache requests.


_imagecache_apply_action($action, &$image)   X-Ref
Apply an action to an image.

param: $action
param: $image
return:

imagecache_transfer($path)   X-Ref
Helper function to transfer files from imagecache.

Determines MIME type and sets a last modified header.

param: $path
return:

_imagecache_cache_set_cache_headers($fileinfo, &$headers)   X-Ref
Set file headers that handle "If-Modified-Since" correctly for the
given fileinfo.

Note that this function may return or may call exit().

Most code has been taken from drupal_page_cache_header().

param: $fileinfo
param:
return:

imagecache_build_derivative($actions, $src, $dst)   X-Ref
Create a new image based on an image preset.

param: $preset
param: $source
param: $destination
return:

imagecache_user($op, &$edit, &$account, $category = NULL)   X-Ref
Implementation of hook_user().


imagecache_file_delete($file)   X-Ref
Implementation of filefield.module's hook_file_delete().

Remove derivative images after the originals are deleted by filefield.

imagecache_field_formatter_info()   X-Ref
Implementation of hook_field_formatter_info().

imagecache formatters are named as $presetname_$style
$style is used to determine how the preset should be rendered.
If you are implementing custom imagecache formatters please treat _ as
reserved.


theme_imagecache_formatter_default($element)   X-Ref
No description

theme_imagecache_formatter_linked($element)   X-Ref
No description

theme_imagecache_formatter_imagelink($element)   X-Ref
No description

theme_imagecache_formatter_path($element)   X-Ref
No description

theme_imagecache_formatter_url($element)   X-Ref
No description

_imagecache_percent_filter($value, $current_pixels)   X-Ref
Accept a percentage and return it in pixels.


_imagecache_keyword_filter($value, $current_pixels, $new_pixels)   X-Ref
Accept a keyword (center, top, left, etc) and return it as an offset in pixels.


_imagecache_recursive_delete($path)   X-Ref
Recursively delete all files and folders in the specified filepath, then
delete the containing folder.

Note that this only deletes visible files with write permission.

param: string $path

theme_imagecache($presetname, $path, $alt = '', $title = '', $attributes = NULL, $getsize = TRUE, $absolute = TRUE)   X-Ref
Create and image tag for an imagecache derivative

param: $presetname
param: $path
param: $alt
param: $title
param: $attributes
param: $getsize
param: $absolute
return:

theme_imagecache_imagelink($presetname, $path, $alt = '', $title = '', $attributes = NULL)   X-Ref
Create a link the original image that wraps the derivative image.

param: $presetname
param: $path
param: $alt
param: $title
param: attributes
return:

imagecache_add_js()   X-Ref
Imagecache JS settings and theme function.


imagecache_presets($reset = FALSE)   X-Ref
Get an array of all presets and their settings.

param: reset
return:

imagecache_preset($preset_id, $reset = FALSE)   X-Ref
Load a preset by preset_id.

param: preset_id
return:

imagecache_preset_by_name($preset_name)   X-Ref
Load a preset by name.

param: preset_name
return:

imagecache_preset_save($preset)   X-Ref
Save an ImageCache preset.

param: preset
return:

imagecache_preset_delete($preset)   X-Ref
No description

imagecache_preset_actions($preset, $reset = FALSE)   X-Ref
No description

imagecache_preset_flush($preset)   X-Ref
Flush cached media for a preset.

param: preset

imagecache_image_flush($path)   X-Ref
Clear cached versions of a specific file in all presets.

param: $path

imagecache_action($actionid)   X-Ref
No description

imagecache_action_load($actionid)   X-Ref
No description

imagecache_action_save($action)   X-Ref
No description

imagecache_action_delete($action)   X-Ref
No description

imagecache_action_info()   X-Ref
Implementation of hook_action_info().

Note: These are actions in the Drupal core trigger.module sense, not
ImageCache actions.

imagecache_flush_action(&$node, $context)   X-Ref
Flush all imagecache presets for a given node.

param: $node
param: $context

imagecache_generate_all_action(&$node, $context)   X-Ref
Generate all imagecache presets for the given node.

param: $node
param: $context

imagecache_generate_action(&$node, $context)   X-Ref
Generate imagecache presets for the given node and presets.

param: $node
param: $context

imagecache_generate_action_form($context)   X-Ref
Form for configuring the generate action.


imagecache_generate_image($presetname, $filepath)   X-Ref
Generate a derivative image given presetname and filepath.

This is a developer friendly version of _imagecache_cache(), it doesn't worry
about sending HTTP headers or an image back to the client so it's much
simpler.

param: $presetname
param: $filepath
return:

imagecache_get_images_in_node(&$node)   X-Ref
Given a node, get all images associated with it.

Currently this only works with images stored in filefields.

param: $node
return:



Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7