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).

Namespace: Alpha\View\Widget
Copyright:

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
Since: 1.0
Located at View/Widget/Image.php

Methods summary

`public`	# `__construct( string $source, $width, $height, $sourceType, $quality = 0.75, $scale = false, $secure = false )` The constructor. The constructor. Parameters `$source` `$width` `$height` `$sourceType` `$quality` `$scale` `$secure` Throws `Alpha\Exception\IllegalArguementException` Since 1.0
`public string`	# `renderHTMLLink( $altText = '' )` Renders the HTML tag to the ViewImage controller, with all of the correct params to render the source image in the desired resolution. Renders the HTML tag to the ViewImage controller, with all of the correct params to render the source image in the desired resolution. Parameters `$altText` this value to render alternate text as part of the HTML link (defaults to no alternate text) Returns string 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( $screenSize = null )` Renders the actual binary image using GD library calls. Renders the actual binary image using GD library calls. Parameters `$screenSize` optional size of the target screen to scale to in the format [X-pixels]x[Y-pixels] 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` Returns string the path of the image Since 1.0

Namespaces

Classes

Class Image

Methods summary

Parameters

Throws

Since

Parameters

Returns

Since

Since

Parameters

Since

Parameters

Returns

Since