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

Source for file filter.php

Documentation is available at filter.php

  1. <?php
  2. /**
  3.  * File containing the ezcImageFilter struct.
  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.  * Struct to store information about a filter operation.
  30.  *
  31.  * The struct contains the {@link self::name name} of the filter to use and
  32.  * which {@link self::options options} to use for it.
  33.  *
  34.  * Possible filter names are determined by the methods defined in the following
  35.  * filter interfaces:
  36.  *
  37.  * <ul>
  38.  *  <li>{@link ezcImageGeometryFilters}</li>
  39.  *  <li>{@link ezcImageColorspaceFilters}</li>
  40.  *  <li>{@link ezcImageEffectFilters}</li>
  41.  *  <li>{@link ezcImageWatermarkFilters}</li>
  42.  *  <li>{@link ezcImageThumbnailFilters}</li>
  43.  * </ul>
  44.  *
  45.  * The options for each filter are represented by the parameters received by
  46.  * their corresponding method. You can determine if a certain {@link }
  47.  * ezcImageHandler} implementation supports a filter by checking the interfaces
  48.  * this handler implements.
  49.  *
  50.  * @see ezcImageTransformation
  51.  *
  52.  * @package ImageConversion
  53.  * @version //autogentag//
  54.  */
  55. class ezcImageFilter extends ezcBaseStruct
  56. {
  57.     /**
  58.      * Name of filter operation to use.
  59.      *
  60.      * @see ezcImageEffectFilters
  61.      * @see ezcImageGeometryFilters
  62.      * @see ezcImageColorspaceFilters
  63.      *
  64.      * @var string 
  65.      */
  66.     public $name;
  67.  
  68.     /**
  69.      * Associative array of options for the filter operation.
  70.      * The array key is the option name and the array entry is the value for
  71.      * the option.
  72.      * Consult each filter operation to see which names and values to use.
  73.      *
  74.      * @see ezcImageEffectFilters
  75.      * @see ezcImageGeometryFilters
  76.      * @see ezcImageColorspaceFilters
  77.      *
  78.      * @var array(string=>mixed) 
  79.      */
  80.     public $options;
  81.  
  82.     /**
  83.      * Initialize with the filter name and options.
  84.      *
  85.      * @see ezcImageFilter::$name
  86.      * @see ezcImageFilter::$options
  87.      *
  88.      * @param array $name    Name of filter operation.
  89.      * @param array $options Associative array of options for filter operation.
  90.      */
  91.     public function __construct$namearray $options array() )
  92.     {
  93.         $this->name    = $name;
  94.         $this->options = $options;
  95.     }
  96. }
  97. ?>
Documentation generated by phpDocumentor 1.4.3