A compact (one-file only) and lightweight PHP library for image manipulation providing methods for performing several types of image manipulation operations and applying filters to images.
Read more here
$chmod_value : integer
Indicates the file system permissions to be set for newly created images.
Better is to leave this setting as it is.
If you know what you are doing, here is how you can calculate the permission levels:
1 Global Execute
Default is 0755
$enlarge_smaller_images : boolean
If set to FALSE, images having both width and height smaller than the required width and height, will be left untouched ({@link jpeg_quality} and {@link png_compression} will still apply).
Available only for the \resize() method
Default is TRUE
$error : integer
In case of an error read this property's value to see the error's code.
Possible error codes are:
9: "exif_read_data" function is not available
Default is 0 (no error).
$auto_handle_exif_orientation :
If set to TRUE, JPEG images will be auto-rotated according to the {@link http://keyj.emphy.de/exif-orientation-rant/ Exif Orientation Tag} so that they are always shown correctly.
If you set this to TRUE you must also enable exif-support with --enable-exif. Windows users must enable both the php_mbstring.dll and php_exif.dll DLL's in php.ini. The php_mbstring.dll DLL must be loaded before the php_exif.dll DLL so adjust your php.ini accordingly. See [the PHP manual](http://php.net/manual/en/exif.installation.php)Default is FALSE
$sharpen_images :
Indicates whether the target image should have a "sharpen" filter applied to it.
Can be very useful when creating thumbnails and should be used only when creating thumbnails.
The sharpen filter relies on the "imageconvolution" PHP function which is available only for PHP version 5.1.0+, and will leave the images unaltered for older versions!
Default is FALSE
apply_filter(string $filter, $arg1 = '', $arg2 = '', $arg3 = '', $arg4 = '')
Applies one or more filters to the image given as {@link source_path} and outputs it as the file specified as {@link target_path}.
This method is available only if the [imagefilter](http://php.net/manual/en/function.imagefilter.php) function is available (available from PHP 5+), and will leave images unaltered otherwise.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// apply the "grayscale" filter $img->apply_filter('grayscale');
// apply the "contrast" filter $img->apply_filter('contrast', -20);
You can also apply multiple filters at once. In this case, the method requires a single argument, an array of arrays, containing the filters and associated arguments, where applicable:
// create a sepia effect
// note how we're applying multiple filters at once
// each filter is in its own array
$img->apply_filter(array(
// first we apply the "grayscale" filter
array('grayscale'),
// then we apply the "colorize" filter with 90, 60, 40 as
// the values for red, green and blue
array('colorize', 90, 60, 40),));
| string | $filter | The (case-insensitive) name of the filter to apply. Can be one of the following: @param mixed $arg1 Used by the following filters:
|
| $arg1 | ||
| $arg2 | ||
| $arg3 | ||
| $arg4 |
crop(integer $start_x, $start_y, $end_x, $end_y)
Crops a portion of the image given as {@link source_path} and outputs it as the file specified as {@link target_path}.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// crop a rectangle of 100x100 pixels, starting from the top-left corner $img->crop(0, 0, 100, 100);
| integer | $start_x | x coordinate to start cropping from @param int $start_y y coordinate to start cropping from @param int $end_x x coordinate where to end the cropping @param int $end_y y coordinate where to end the cropping @since 1.0.4 @return bool Returns TRUE on success or FALSE on error. |
| $start_y | ||
| $end_x | ||
| $end_y |
flip_both()
Flips both horizontally and vertically the image given as {@link source_path} and outputs the resulted image as {@link target_path}.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// flip the image both horizontally and vertically $img->flip_both();
flip_horizontal() : boolean
Flips horizontally the image given as {@link source_path} and outputs the resulted image as {@link target_path}.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// flip the image horizontally $img->flip_horizontal();
Returns TRUE on success or FALSE on error.
If FALSE is returned, check the {@link error} property to see the error code.flip_vertical() : boolean
Flips vertically the image given as {@link source_path} and outputs the resulted image as {@link target_path}.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// flip the image vertically $img->flip_vertical();
Returns TRUE on success or FALSE on error.
If FALSE is returned, check the {@link error} property to see the error code.resize(integer $width, $height, $method = ZEBRA_IMAGE_CROP_CENTER, $background_color = -1)
Resizes the image given as {@link source_path} and outputs the resulted image as {@link target_path}.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// apply a "sharpen" filter to the resulting images $img->sharpen_images = true;
// resize the image to exactly 150x150 pixels, without altering // aspect ratio, by using the CROP_CENTER method $img->resize(150, 150, ZEBRA_IMAGE_CROP_CENTER);
| integer | $width | The width to resize the image to. @param int $height The height to resize the image to. @param int $method (Optional) Method to use when resizing images to exact width and height while preserving aspect ratio. @param hexadecimal $background_color (Optional) The hexadecimal color (like "#FFFFFF" or "#FFF") of the blank area. See the method argument. @return bool Returns TRUE on success or FALSE on error. |
| $height | ||
| $method | ||
| $background_color |
rotate(float $angle, $background_color = -1)
Rotates the image given as {@link source_path} and outputs the resulted image as {@link target_path}.
// include the Zebra_Image library
require 'path/to/Zebra_Image.php';
// instantiate the class $img = new Zebra_Image();
// a source image $img->source_path = 'path/to/source.ext';
// path to where should the resulting image be saved // note that by simply setting a different extension to the file will // instruct the script to create an image of that particular type $img->target_path = 'path/to/target.ext';
// rotate the image 45 degrees, clockwise $img->rotate(45);
| float | $angle | Angle by which to rotate the image clockwise. @param mixed $background_color (Optional) The hexadecimal color (like "#FFFFFF" or "#FFF") of the uncovered zone after the rotation. @return bool Returns TRUE on success or FALSE on error. |
| $background_color |
_hex2rgb(string $color, $default_on_error = '#FFFFFF')
Converts a hexadecimal representation of a color (i.e. #123456 or #AAA) to a RGB representation.
The RGB values will be a value between 0 and 255 each.
| string | $color | Hexadecimal representation of a color (i.e. #123456 or #AAA). @param string $default_on_error (Optional) Hexadecimal representation of a color to be used in case $color is not recognized as a hexadecimal color. @return array Returns an associative array with the values of (R)ed, (G)reen and (B)lue |
| $default_on_error |
_prepare_image( $width, integer $height, $background_color = '#FFFFFF')
Creates a blank image of given width, height and background color.
@param int $width width of the new image
| $width | ||
| integer | $height | height of the new image @param string $background_color (Optional) The hexadecimal color of the background. @return Returns the identifier of the newly created image |
| $background_color |
_sharpen_image( $image)
Sharpens images. Useful when creating thumbnails.
Code taken from the comments at http://docs.php.net/imageconvolution.
This function will yield a result only for PHP version 5.1.0+ and will leave the image unaltered for older versions!
| $image |
_write_image( $identifier) : boolean
Creates a new image from given image identifier having the extension as specified by {@link target_path}.
@param $identifier identifier An image identifier
| $identifier |
Returns TRUE on success or FALSE on error.
If FALSE is returned, check the {@link error} property to see the error code.