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

Source for file converter_settings.php

Documentation is available at converter_settings.php

  1. <?php
  2. /**
  3.  * File containing the ezcImageConverterSettings 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 the settings for objects of ezcImageConverter.
  30.  *
  31.  * This class is used as a struct for the settings of ezcImageConverter.
  32.  *
  33.  * @see ezcImageConverter
  34.  *
  35.  * @package ImageConversion
  36.  * @version //autogentag//
  37.  */
  38. {
  39.     /**
  40.      * Array with {@link ezcImageHandlerSettings handler settings} objects.
  41.      * Each settings objects is consulted by the converter to figure out which
  42.      * {@link ezcImageHandler image handlers} to use.
  43.      *
  44.      * @see ezcImageHandler
  45.      * @see ezcImageGdHandler
  46.      * @see ezcImageImagemagickHandler
  47.      *
  48.      * @var array(ezcImageHandlerSettings) 
  49.      */
  50.     public $handlers = array();
  51.  
  52.     /**
  53.      * Map of automatic MIME type conversions. The converter will automatically
  54.      * perform the defined conversions when a transformation is applied through
  55.      * it and the specific MIME type is recognized.
  56.      *
  57.      * The conversion map has the following structure:
  58.      * <code>
  59.      * array(
  60.      *     'image/gif' => 'image/png',  // Note: lower case!
  61.      *     'image/bmp' => 'image/jpeg',
  62.      * )
  63.      * </code>
  64.      *
  65.      * @var array 
  66.      */
  67.     public $conversions = array();
  68.  
  69.     /**
  70.      * Create a new instance of ezcImageConverterSettings.
  71.      * Create a new instance of ezcImageConverterSettings to be used with
  72.      * {@link ezcImageConverter} objects..
  73.      *
  74.      * @see ezcImageConverterSettings::$handlers
  75.      * @see ezcImageConverterSettings::$conversions
  76.      *
  77.      * @param array $handlers    Array of {@link ezcImageHandlerSettings handler objects}.
  78.      * @param array $conversions Map of standard MIME type conversions.
  79.      */
  80.     public function __constructarray $handlers array()array $conversions array() )
  81.     {
  82.         $this->handlers    = $handlers;
  83.         $this->conversions = $conversions;
  84.     }
  85. }
  86. ?>
Documentation generated by phpDocumentor 1.4.3