Apache Zeta Components Manual :: File Source for thumbnail.php

Source for file thumbnail.php

Documentation is available at thumbnail.php

  1. <?php
  2. /**
  3.  * File containing the ezcImageThumbnailFilters interface.
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @package ImageConversion
  23.  * @version //autogentag//
  24.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  25.  * @filesource
  26.  */
  27.  
  28. /**
  29.  * This interface has to implemented by ezcImageFilters classes to
  30.  * support thumbnail filters.
  31.  *
  32.  * @see ezcImageHandler
  33.  * @see ezcImageTransformation
  34.  * @see ezcImageFiltersInterface
  35.  *
  36.  * @package ImageConversion
  37.  * @version //autogentag//
  38.  */
  39. {
  40.     /**
  41.      * Creates a thumbnail, and crops parts of the given image to fit the range best.
  42.      * This filter creates a thumbnail of the given image. The image is scaled
  43.      * down, keeping the original ratio and keeping the image larger as the
  44.      * given range, if necessary. Overhead for the target range is cropped from
  45.      * both sides equally.
  46.      *
  47.      * If you are looking for a filter that just resizes your image to
  48.      * thumbnail size, you should consider the {@link }
  49.      * ezcImageGeometryFilters::scale()} filter.
  50.      *
  51.      * @param int $width  Width of the thumbnail.
  52.      * @param int $height Height of the thumbnail.
  53.      */
  54.     public function croppedThumbnail$width$height );
  55.  
  56.     /**
  57.      * Creates a thumbnail, and fills up the image to fit the given range.
  58.      * This filter creates a thumbnail of the given image. The image is scaled
  59.      * down, keeping the original ratio and scaling the image smaller as the
  60.      * given range, if necessary. Overhead for the target range is filled with the given
  61.      * color on both sides equally.
  62.      *
  63.      * The color is defined by the following array format (integer values 0-255):
  64.      *
  65.      * <code>
  66.      * array(
  67.      *      0 => <red value>,
  68.      *      1 => <green value>,
  69.      *      2 => <blue value>,
  70.      * );
  71.      * </code>
  72.      *
  73.      * If you are looking for a filter that just resizes your image to
  74.      * thumbnail size, you should consider the {@link }
  75.      * ezcImageGeometryFilters::scale()} filter.
  76.      * 
  77.      * @param int $width  Width of the thumbnail.
  78.      * @param int $height Height of the thumbnail.
  79.      * @param array $color Fill color.
  80.      * @return void 
  81.      */
  82.     public function filledThumbnail$width$height$color array() );
  83. }
  84.  
  85. ?>
Documentation generated by phpDocumentor 1.4.3