canvas

» Download now .zip

Canvas is a PHP class to manipulate images, including resize functions, filters, crop, conversion and method chaining.

How to use

The code below will load an image file called "image.jpg", resize it to 30% of its width and convert it to grayscale. Once it's all done, the image gets displayed on the screen.

<?php 
require_once "canvas.php";
$img = new canvas;
$img->load("image.jpg")->resize("30%")->filter("grayscale")->show();

Next one will load the file called "banksky3.jpg" located at the "img" directory (this time using the class constructor), resize with crop (setting manually the crop coordinates), add some credits text to the image and finally save it as a new image, with a different format ("new_image.png" at "/tmp" dir).

<?php 
require_once "canvas.php";
$img = new canvas("img/banksky3.jpg");
$img->set_crop_coordinates(-400, -410)
    ->resize("938", "240", "crop")
    ->filter("grayscale")
    ->text("banksky.co.uk", array(
           "color" => "#000",
           "background_color" => "#ffff00", 
           "size" => 4, 
           "x" => "right", 
           "y" => "top"))
    ->save("/tmp/new_image.png");

For a full list of features, check the api documentation

$img = new canvas("image.jpg");

$img = new canvas();
$img->load("image.jpg");

$img = new canvas();
$img->load_url("http://www.google.com.br/images/srpr/logo2w.png");

$img = new canvas();
$img->create_empty_image(200, 100, "png", 90)->show();

$img = new canvas("example.jpg");
$img->set_rgb(array(255, 73, 84))->resize(200, 300, "fill")->save("example.jpg");
$img->set_rgb("#fff")->create_empty_image(200, 200)->save("example.png");

$img = new canvas("example.jpg");
$img->set_crop_coordinates(-100, -80)->resize(200, 300, "crop")->show();

$img = new canvas("example.png");
$img->resize(200, 300, "crop")->save("example_crop.png");
$img->resize(200, 300, "fill")->save("example_fill.png");
$img->resize(200, 300)->save("example_simple.png");
$img->resize("20%", "40%", "fill")->save("example_percentage.png");
$img->resize(200)->save("example_proportional.png");

$img = new canvas("example.gif");
$img->flip("vertical")->show();

$img = new canvas("example.jpg");
$img->set_rgb("#fff")->rotate(90)->save("example.png");

$options = array(
  "color" => "#000",
  "background_color" => "#ffff00", 
  "size" => 4, 
  "x" => "right", 
  "y" => "top"
);
$img = new canvas("example.png");
$img->text("My text", $options)->show();

$img = new canvas("example.png")
$img->merge("example.png", array("right", "bottom"), 60)->show();

$img = new canvas("example.png");
$img->filter("grayscale")->save("example_bw.png");
$img->filter("blur", 5)->save("example_blur.png");

$img = new canvas("example.png");
$img->resize("30%")->set_quality(100)->show();

$img = new canvas("example.png");
$img->resize(300, 200, "crop")->save("/tmp/example.gif");

$img = new canvas("example.gif");
$img->resize(200)->show();

$img = new canvas("invalid.jpg");
if(!$img->resize(200))
  die($img->error_message());

Requirements

• PHP version 5+
• GD library installed and configured on the webserver
• PHP 5.2+ if you are planning to use filters
• PHP compiled with truetype support if you want to use special fonts on your image texts

Examples (coming soon!)

• Simple resizes
• Dynamic placeholder image
• Truetype text
• Dynamic thumbnails
• Canvas and jCrop
• Canvas and .htaccess
• Canvas image editor
• Dynamic image gallery

Troubleshooting

If you are having trouble getting Canvas to work, please check the following list before asking for help:

1. Are you using the correct PHP version (5+)?
2. Is the GD library enabled and configured on your web server?
3. Do you have write permissions? (in case you are trying to save some image)
4. Is your script returning anything before the image you are trying to show?

Also, for debugging purposes, enable PHP error reporting on your script:

error_reporting(E_ALL ^ E_NOTICE ^ E_USER_NOTICE);
ini_set( 'display_errors',1 );
ini_set( 'display_startup_errors', true );

If you are still experiencing trouble, please drop a new issue at GitHub and I'll take a look at it! You can also follow me on twitter for updates and help.

Who is using it

Credits

Canvas PHP image manipulation class written by Davi Ferreira.

I would like to thank the following people for helping me out with this class along the way:

• DHKold - imagecreatefrombmp
• Estefanio Nunes - Utility belt
• Fernando VR - proportional resize fixes
• Gilton Guma - resize fixes
• Giolvani - image merge positions
• Noah Winecoff - crop and flip
• Patrick Kaminski - oraculum framework
• ... and everybody else that mailed me suggestions and commented on both posts about Canvas! :)

Aller font by Dalton Maag, interface elements by Wijmo.