[ Index ]

PHP Cross Reference of phpwcms V1.5.0 _r431 (28.01.12)

title

Body

[close]

/include/inc_lib/ -> helper.image.php (summary)

(no description)

File Size: 1664 lines (44 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Phpwcms_Image_lib:: (26 methods):
  __construct()
  clear()
  initialize()
  resize()
  crop_centered_resize()
  crop()
  rotate()
  image_process_gd()
  image_process_imagemagick()
  image_process_netpbm()
  image_rotate_gd()
  image_mirror_gd()
  watermark()
  overlay_watermark()
  text_watermark()
  image_create_gd()
  image_save_gd()
  image_display_gd()
  image_reproportion()
  get_image_properties()
  size_calculator()
  explode_name()
  gd_loaded()
  gd_version()
  set_error()
  display_errors()


Class: Phpwcms_Image_lib  - X-Ref

Image Manipulation class

Taken from CodeIgniter and adopted for use in phpwcms.

__construct($props = array()   X-Ref
Constructor

param: string
return: void

clear()   X-Ref
Initialize image properties

Resets values in case this class is used in a loop.

return: void

initialize($props = array()   X-Ref
initialize image preferences

param: array
return: bool

resize()   X-Ref
Image Resize

This is a wrapper function that chooses the proper
resize function based on the protocol specified

return: bool

crop_centered_resize()   X-Ref
Image Centered Crop and Resize

This is a wrapper function that chooses the proper
cropping and resize function based on the protocol specified
but only available for ImageMagick

return: bool

crop()   X-Ref
Image Crop

This is a wrapper function that chooses the proper
cropping function based on the protocol specified

return: bool

rotate()   X-Ref
Image Rotate

This is a wrapper function that chooses the proper
rotation function based on the protocol specified

return: bool

image_process_gd($action = 'resize')   X-Ref
Image Process Using GD/GD2

This function will resize or crop

param: string
return: bool

image_process_imagemagick($action = 'resize')   X-Ref
Image Process Using ImageMagick

This function will resize, crop or rotate

param: string
return: bool

image_process_netpbm($action = 'resize')   X-Ref
Image Process Using NetPBM

This function will resize, crop or rotate

param: string
return: bool

image_rotate_gd()   X-Ref
Image Rotate Using GD

return: bool

image_mirror_gd()   X-Ref
Create Mirror Image using GD

This function will flip horizontal or vertical

return: bool

watermark()   X-Ref
Image Watermark

This is a wrapper function that chooses the type
of watermarking based on the specified preference.

param: string
return: bool

overlay_watermark()   X-Ref
Watermark - Graphic Version

return: bool

text_watermark()   X-Ref
Watermark - Text Version

return: bool

image_create_gd($path = '', $image_type = '')   X-Ref
Create Image - GD

This simply creates an image resource handle
based on the type of image being processed

param: string
return: resource

image_save_gd($resource)   X-Ref
Write image file to disk - GD

Takes an image resource as input and writes the file
to the specified destination

param: resource
return: bool

image_display_gd($resource)   X-Ref
Dynamically outputs an image

param: resource
return: void

image_reproportion()   X-Ref
Re-proportion Image Width/Height

When creating thumbs, the desired width/height
can end up warping the image due to an incorrect
ratio between the full-sized image and the thumb.

This function lets us re-proportion the width/height
if users choose to maintain the aspect ratio when resizing.

return: void

get_image_properties($path = '', $return = FALSE)   X-Ref
Get image properties

A helper function that gets info about the file

param: string
return: mixed

size_calculator($vals)   X-Ref
Size calculator

This function takes a known width x height and
recalculates it to a new size.  Only one
new variable needs to be known

$props = array(
'width'            => $width,
'height'        => $height,
'new_width'        => 40,
'new_height'    => ''
);

param: array
return: array

explode_name($source_image, $ext_only=FALSE)   X-Ref
Explode source_image

This is a helper function that extracts the extension
from the source_image.  This function lets us deal with
source_images with multiple periods, like:  my.cool.jpg
It returns an associative array with two elements:
$array['ext']  = '.jpg';
$array['name'] = 'my.cool';

param: string
param: bool
return: array

gd_loaded()   X-Ref
Is GD Installed?

return: bool

gd_version()   X-Ref
Get GD version

return: mixed

set_error($msg)   X-Ref
Set error message

param: string
return: void

display_errors($open = '<p>', $close = '</p>', $wrap_open='', $wrap_close='')   X-Ref
Show error messages

param: string
return: string



Generated: Sun Jan 29 16:31:14 2012 Cross-referenced by PHPXref 0.7.1