# Class Image

A widget that can generate an image which is scaled to the screen resolution of the user, and can be made secured to prevent hot-linking from remote sites. Note that by default, a jpg file will be returned (the source file can be jpg, png, or gif).

Package: alpha::view::widgets
Copyright: Copyright (c) 2013, John Collins (founder of Alpha Framework). All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, are permitted provided that the
    following conditions are met:

    * Redistributions of source code must retain the above
      copyright notice, this list of conditions and the
      following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the
      following disclaimer in the documentation and/or other
      materials provided with the distribution.
    * Neither the name of the Alpha Framework nor the names
      of its contributors may be used to endorse or promote
      products derived from this software without specific
      prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: Image.inc 1669 2013-09-12 20:38:17Z alphadevx $
Since: 1.0
Located at view/widgets/Image.inc

Methods summary
`public` | # `__construct( mixed $source, mixed $width, mixed $height, mixed $sourceType, mixed $quality = 0.75, mixed $scale = false, mixed $secure = false )` The constructor. The constructor. #### Parameters $source `mixed` $source $width `mixed` $width $height `mixed` $height $sourceType `mixed` $sourceType $quality `mixed` $quality $scale `mixed` $scale $secure #### Throws ``IllegalArguementException`` #### Since 1.0
`public string` | # `renderHTMLLink( mixed $altText = '' )` Renders the HTML <img> tag to the ViewImage controller, with all of the correct params to render the source image in the desired resolution. Renders the HTML <img> tag to the ViewImage controller, with all of the correct params to render the source image in the desired resolution. #### Parameters $altText `mixed` $altText Set this value to render alternate text as part of the HTML link (defaults to no alternate text) #### Returns `string` #### Since 1.0
`private` | # `setFilename( )` Setter for the filename, which also creates a sub-directory under /cache for images when required Setter for the filename, which also creates a sub-directory under /cache for images when required #### Throws ``AlphaException`` #### Since 1.0
`public` | # `getFilename( )` Gets the auto-generated filename for the image in the /cache directory Gets the auto-generated filename for the image in the /cache directory #### Since 1.0
`public` | # `renderImage( )` Renders the actual binary image using GD library calls. Renders the actual binary image using GD library calls. #### Since 1.0
`private` | # `cache( image $image )` Caches the image to the cache directory Caches the image to the cache directory #### Parameters $image `image` $image the binary GD image stream to save #### Since 1.0
`private boolean` | # `checkCache( )` Used to check the image cache for the image jpeg cache file. Used to check the image cache for the image jpeg cache file. #### Returns `boolean` #### Since 1.0
`private` | # `loadCache( )` Method to load the content of the image cache file to the standard output stream (the browser) Method to load the content of the image cache file to the standard output stream (the browser) #### Since 1.0
`public static string` | # `convertImageURLToPath( string $imgURL )` Converts a URL for an image to a relative file system path for the image, assuming it is hosted on the same server as the application. Converts a URL for an image to a relative file system path for the image, assuming it is hosted on the same server as the application. #### Parameters $imgURL `string` $imgURL #### Returns `string` the path of the image #### Since 1.0

Properties summary
`private string` | $title | `` | # The title of the image for alt text (optional). The title of the image for alt text (optional). #### Since 1.0
`private string` | $source | `` | # The absolute path to the source image. The absolute path to the source image. #### Since 1.0
`private `Integer`` | $width | `` | # The width of the image (can differ from the source file when scale=true). The width of the image (can differ from the source file when scale=true). #### Since 1.0
`private `Integer`` | $height | `` | # The height of the image (can differ from the source file when scale=true). The height of the image (can differ from the source file when scale=true). #### Since 1.0
`private `Enum`` | $sourceType | `` | # The file type of the source image (gif, jpg, or png supported) The file type of the source image (gif, jpg, or png supported) #### Since 1.0
`private `Double`` | $quality | `` | # The quality of the jpg image generated (0.00 to 1.00, 0.75 by default). The quality of the jpg image generated (0.00 to 1.00, 0.75 by default). #### Since 1.0
`private `Boolean`` | $scale | `` | # Flag to determine if the image will scale to match the target resolution (false by default). Flag to determine if the image will scale to match the target resolution (false by default). #### Since 1.0
`private `Boolean`` | $secure | `` | # Flag to determine if the link to the image will change every 24hrs, making hot-linking to the image difficult (false by default). Flag to determine if the link to the image will change every 24hrs, making hot-linking to the image difficult (false by default). #### Since 1.0
`private string` | $filename | `` | # The auto-generated name of the cache file for the image. The auto-generated name of the cache file for the image. #### Since 1.0
`private static `Logger`` | $logger | `null` | # Trace logger Trace logger #### Since 1.0