Files
FHC-Core/include/ezcomponents/ImageConversion/src/interfaces/thumbnail.php
T
Andreas Österreicher 0a8e90a8b3 EZ-Components
2009-02-17 15:27:43 +00:00

71 lines
2.3 KiB
PHP

<?php
/**
* File containing the ezcImageThumbnailFilters interface.
*
* @package ImageConversion
* @version 1.3.5
* @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved.
* @license http://ez.no/licenses/new_bsd New BSD License
* @filesource
*/
/**
* This interface has to implemented by ezcImageFilters classes to
* support thumbnail filters.
*
* @see ezcImageHandler
* @see ezcImageTransformation
* @see ezcImageFiltersInterface
*
* @package ImageConversion
* @version 1.3.5
*/
interface ezcImageThumbnailFilters
{
/**
* Creates a thumbnail, and crops parts of the given image to fit the range best.
* This filter creates a thumbnail of the given image. The image is scaled
* down, keeping the original ratio and keeping the image larger as the
* given range, if necessary. Overhead for the target range is cropped from
* both sides equally.
*
* If you are looking for a filter that just resizes your image to
* thumbnail size, you should consider the {@link
* ezcImageGeometryFilters::scale()} filter.
*
* @param int $width Width of the thumbnail.
* @param int $height Height of the thumbnail.
*/
public function croppedThumbnail( $width, $height );
/**
* Creates a thumbnail, and fills up the image to fit the given range.
* This filter creates a thumbnail of the given image. The image is scaled
* down, keeping the original ratio and scaling the image smaller as the
* given range, if necessary. Overhead for the target range is filled with the given
* color on both sides equally.
*
* The color is defined by the following array format (integer values 0-255):
*
* <code>
* array(
* 0 => <red value>,
* 1 => <green value>,
* 2 => <blue value>,
* );
* </code>
*
* If you are looking for a filter that just resizes your image to
* thumbnail size, you should consider the {@link
* ezcImageGeometryFilters::scale()} filter.
*
* @param int $width Width of the thumbnail.
* @param int $height Height of the thumbnail.
* @param array $color Fill color.
* @return void
*/
public function filledThumbnail( $width, $height, $color = array() );
}
?>