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

Documentation generated by phpDocumentor 1.4.3