Development

/plugins/sfImageTransformExtraPlugin/trunk/README

You must first sign up to be able to contribute.

root/plugins/sfImageTransformExtraPlugin/trunk/README

Revision 28526, 2.4 kB (checked in by caefer, 3 years ago)

typo

Line 
1 # Image manipulation made even easier - sfImageTransformExtraPlugin
2
3 ![sfImageTransformExtraPlugin](http://www.symfony-project.org/uploads/plugins/4366ffec3f32548c30e31094c3dcbcea.png)
4
5 ## Introduction
6
7 On a website you ususally find lots of images and a set of formats. Say a user avatar is always ``80x80 PNG`` while a homepage top image is always ``320x140 JPG`` with round corners. As it is far too costly to prepare all these different formats by hand there are automated ways to generate them from source images uploaded by a user. One of the best tools for this in the symfony world is the [sfImageTransformPlugin](http://www.symfony-project.org/plugins/sfImageTransformPlugin) which enables you to perform many sophisticated transformations on your images such as resizing, color manipulation, overlays and more.
8
9 Using such an automatism means you have to write code and perform all necessary transformation on upload, no matter if the generated files are ever requested. It also means that design changes that also change the formats lead to change of business logic rather than just templates.
10
11 This is where sfImageTransformExtraPlugin springs to action as it provides a way to configure formats with multiple transformations.
12 In your templates you only refer to the format by name which results in an SEO friendly image URL. The image itself will be generated on first request and (in production environments) written to the filesystem.
13
14 Here are some of the key features:
15
16 *   Configure image transformation for your thumbnail formats
17 *   Format changes without the need to change code
18 *   Unobstrusive implementation (No need to write code)
19 *   Generating images on request
20 *   Can be run as a web service for a content delivery network (CDN)
21 *   Supporting image file sources from Doctrine and remote files
22 *   SEO friendly URLs
23 *   Generated API documentation
24 *   Unit tested
25 *   Easily to extend
26
27 ## Installation
28
29 To install the plugin for a symfony project, the usual process is to use the symfony command line:
30
31 symfony 1.4
32
33     symfony plugin:install sfImageTransformExtraPlugin
34
35 Alternatively, if you don't have PEAR installed, you can download the latest package attached to this plugin's wiki page and extract it under your project's ``plugins/`` directory.
36
37 Clear the cache to enable the autoloading to find the new classes:
38
39     php symfony cc
40
41 Note: The plugin requires sfImageTransformPlugin to be installed as well. The dependencies described there apply as well.
42
Note: See TracBrowser for help on using the browser.