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

Source for file handler_settings.php

Documentation is available at handler_settings.php

  1. <?php
  2. /**
  3.  * File containing the ezcImageHandlerSettings 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 ezcImageHandler.
  30.  *
  31.  * This class is used as a struct for the settings of ezcImageHandler
  32.  * subclasses.
  33.  *
  34.  * @see ezcImageHandler
  35.  *
  36.  * @package ImageConversion
  37.  * @version //autogentag//
  38.  */
  39. {
  40.     /**
  41.      * The reference name for the handler.
  42.      * This name can be used when referencing the handler in certain operations
  43.      * in the {@link ezcImageConverter converter} class.
  44.      *
  45.      * e.g. 'GD' and 'ImageMagick'.
  46.      *
  47.      * @var string 
  48.      */
  49.     public $referenceName;
  50.  
  51.     /**
  52.      * Name of the class to instantiate as image handler.
  53.      *
  54.      * Note: This class must be a subclass of the {@link ezcImageHandler} class.
  55.      *
  56.      * @var string 
  57.      */
  58.     public $className;
  59.  
  60.     /**
  61.      * Associative array of misc options for the handler.
  62.      * These options will be read by the handler class and varies from handler
  63.      * to handler. Consult the handler class for the available settings.
  64.      *
  65.      * The options array has the following structure:
  66.      * <code>
  67.      * array(
  68.      *     <optionName> => <optionValue>,
  69.      *     [ <optionName> => <optionValue>, ...]
  70.      * )
  71.      * </code>
  72.      *
  73.      * @var array 
  74.      */
  75.     public $options = array();
  76.  
  77.     /**
  78.      * Initialize settings to be used by image handler.
  79.      * The settings passed as parameter will be read by the
  80.      * {@link ezcImageConverter converter} to figure out which image handler to
  81.      * use and then passed to the {@link ezcImageHandler image handler objects}.
  82.      *
  83.      * @see ezcImageHandlerSettings::$referenceName
  84.      * @see ezcImageHandlerSettings::$className
  85.      * @see ezcImageHandlerSettings::$settings
  86.      *
  87.      * @param string $referenceName 
  88.      *         The reference name for the handler, e.g. 'GD' or 'ImageMagick'
  89.      * @param string $className 
  90.      *         The name of the handler class to instantiate, e.g.
  91.      *         'ezcImageGdHandler' or 'ezcImageImagemagickHandler'
  92.      * @param array  $options 
  93.      *         Associative array of settings for the handler.
  94.      */
  95.     public function __construct$referenceName$classNamearray $options array() )
  96.     {
  97.         $this->referenceName = $referenceName;
  98.         $this->className     = $className;
  99.         $this->options       = $options;
  100.     }
  101. }
  102. ?>
Documentation generated by phpDocumentor 1.4.3