@@ -1,6 +1,6 @@ <?php -include("ImageResize.php"); +require_once("ImageResize.php"); class ImageResizeController extends PluginController { ImageResizeController.php @@ -1,37 +1,56 @@ -IMAGE RESIZE +Image Resize for Frog +===================== -Peter Gassner, 2008 -http://www.naehrstoff.ch/code/image-resize-for-frog +This plugin has been tested with Frog version 0.9.4. It's homepage is: -This plugin has been tested with Frog 0.9.2. +`http://www.naehrstoff.ch/code/image-resize-for-frog` -ABOUT +About +----- With the Image Resize plugin enabled, you can easily create thumbnails of your images. It was inspired by the Drupal Image Cache module. The image resize functions are taken from Drupal and adapted for Frog CMS. -HOW TO USE +How to use +---------- Just include images as you normally would, but instead of linking to the original file, append a dimension to the filename. This is best shown with an example. Where you would normally reference an image like this: -* <img src="public/images/flower.jpg" alt="" /> +`<img src="public/images/flower.jpg" alt="" />` You can now add a dimension identifier directly before the file extension like this: -* <img src="public/images/flower.230x150.jpg" alt="" /> +`<img src="public/images/flower.230x150.jpg" alt="" />` This tells the plugin to generate an image that fits within the width of 230 and the height of 150. It is possible to use only one parameter as an argument: -* <img src="public/images/flower.230.jpg" alt="" /> (resize to width) -* <img src="public/images/flower.x150.jpg" alt="" /> (resize to height) +* `<img src="public/images/flower.230.jpg" alt="" />` (resize to width) +* `<img src="public/images/flower.x150.jpg" alt="" />` (resize to height) + +Since version 1.1.0 you can also use a PHP-function to create the image tags: + +`<?php echo image_resize_image_tag($path_to_file, $width = NULL, $height = NULL, $options = array()); ?>` Of course the original file (flower.jpg) has to exist. The thumbnails will be created in the same folder as the original file. +Contributors +------------ + +* Peter Gassner <peter@naehrstoff.ch> + +Changelog +--------- +* 1.1.0 (November 12, 2008) + * Added globally accessible function `image_resize_image_tag()` to create image tags programmatically. + * Removed need to reload after thumbnail creation + * Updated for compatibility with Frog v0.9.4 +* 1.0.0 (February 3, 2008) + * First version for Frog v0.9.2 \ No newline at end of file README.markdown @@ -1,6 +1,6 @@ <?php -include("ImageResize.php"); +require_once("ImageResize.php"); Plugin::setInfos(array( 'id' => 'image_resize', @@ -80,6 +80,7 @@ function image_resize_scale($path) { /** * Helper function to create an image tag */ + function image_resize_image_tag($image_path, $width = NULL, $height = NULL, $options = array()) { if (!array_key_exists("alt", $options)) $options['alt'] = ''; $html_options = ""; index.php @@ -1,4 +1,5 @@ -<h1>Image Resize</h1> +<h1>Documentation</h1> +<h2>Image Resize</h2> <p>With the <em>Image Resize</em> plugin enabled, you can easily create thumbnails of your images.</p> @@ -42,19 +43,18 @@ <li><code><img src="public/images/flower.<strong>x150</strong>.jpg" alt="" /></code> (resize to height)</li> </ul> -<p>Of course the original file (<code>flower.jpg</code>) has to exist. The thumbnails will be created in the same folder as the original file.</p> +<p>Since version 1.1.0 you can also use a PHP-function to create the image tags:</p> +<p><code><?php echo image_resize_image_tag($path_to_file, $width = NULL, $height = NULL, $options = array()); ?></code></p> -<h3>Important notes</h3> +<p>Of course the original file (<code>flower.jpg</code>) has to exist. The thumbnails will be created in the same folder as the original file.</p> -<p>Because the images are generated on first access, they won't show up in the browser the first time a page is viewed. A reload lets the flowers blossom!</p> -<p>Also, because access to plugins is restricted to certain roles, an administrator has to visit a page with a thumbnail that has not yet been resized in order to make the magic happen. Ordinary visitors don't have the permissions to create thumbnails.</p> <h3>How does it work?</h3> -<p>This module relies on some mod_rewrite magic: If the requested thumbnail exists, Apache knows this and delivers the file to the browser. If the file doesn't exist, Apache hands control over to Frog CMS.</p> +<p>This module relies on some <code>mod_rewrite</code> magic: If the requested thumbnail exists, Apache knows this and delivers the file to the browser. If the file doesn't exist, Apache hands control over to Frog CMS.</p> -<p>Frog won't find the file either, so it sends a page-not-found message. This is the moment where the Image Resize plugin suddenly feels responsible. It checks whether an image without the dimension specifier exists (<code>flower.jpg</code>) and converts it into a thumbnail with the requested name (<code>flower.230x150.jpg</code>). The next time someone asks for that file it will be there!</p> +<p>Frog won't find the file either, so it sends a <code>page_not_found</code> message. This is the moment where the Image Resize plugin suddenly feels responsible. It checks whether an image without the dimension specifier exists (<code>flower.jpg</code>) and converts it into a thumbnail with the requested name (<code>flower.230x150.jpg</code>). The next time someone asks for that file it will be there!</p> <h3>About this plugin</h3> @@ -62,8 +62,8 @@ <p>It was inspired by the Drupal <a href="http://drupal.org/project/imagecache">Image Cache</a> module. The image resize functions are taken from <a href="http://drupal.org/">Drupal</a> and adapted for Frog CMS.</p> -<p>The plugin can be installed via Subversion. In your Frog CMS plugin folder, execute the following command (all on one line):</p> +<p>The plugin can be installed via Github, where you can either download a ZIP-file or checkout the Git repository.</p> -<p><code>svn co http://www.naehrstoff.ch/svn/frog_image_resize ./image_resize</code></p> +<p><a href="http://github.com/naehrstoff/image-resize-for-frog/tree/master">Download the plugin</a> from Github.</p> -<p>Patches are very welcome!</p> \ No newline at end of file +<p>Patches and suggestions are very welcome!</p> \ No newline at end of file views/documentation.php a9b50c1b61aaed3f7a1827baa3c28a373f00f6f1 Peter Gassner peter@naehrstoff.ch http://github.com/naehrstoff/image_resize/commit/5d3d4dfb303228ee7760ac3ab550261b771affd2 5d3d4dfb303228ee7760ac3ab550261b771affd2

2008-11-12T07:54:31-08:00

Preparations for release. 1d950ae21bb9ee1bec99a2435e6f8df667af3ba8 Peter Gassner peter@naehrstoff.ch