Make the new default_driver configuration backwards-compatible
[kohana-image.git] / guide / image / index.md
blobdd1e6b8cb527cff0680923c19dff28084ab1b3cf
1 # Image
3 Kohana 3.x provides a simple yet powerful image manipulation module. The [Image] module provides features that allows your application to resize images, crop, rotate, flip and many more.
5 ## Drivers
7 [Image] module ships with [Image_GD] driver which requires `GD` extension enabled in your PHP installation, and
8 [Image_Imagick] driver which requires the `imagick` PHP extension. Additional drivers can be created by extending 
9 the [Image] class.
11 The [Image_GD] driver is the default. You can change this by providing an `image.default_driver` configuration option
12 - for example:
14 ~~~
15 // application/config/image.php
16 <?php
17 return array(
18     'default_driver' => 'Imagick'
20 ~~~
22 [!!] Older versions of Kohana allowed you to configure the driver with the `Image::$default_driver` static variable in
23 the bootstrap, an extension class, or elsewhere. That variable is now deprecated and will be ignored if you set a 
24 config value. 
26 ## Getting Started
28 Before using the image module, we must enable it first on `APPPATH/bootstrap.php`:
30 ~~~
31 Kohana::modules(array(
32     ...
33     'image' => MODPATH.'image',  // Image manipulation
34     ...
35 ));
36 ~~~
38 Next: [Using the image module](using).