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

Documentation generated by phpDocumentor 1.4.3