## Apache Zeta Components Manual :: File Source for stack_configurator.php

## Source for file stack_configurator.php

Documentation is available at stack_configurator.php

1. <?php
2. /**
3. * File containing the ezcCacheStackConfigurator interface.
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 Cache
23. * @version //autogentag//
24. * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
25. * @filesource
26. */
28. /**
29. * Interface to be implemented by stack configurator classes.
30. *
31. * To allow the usage of {@link ezcCacheStack} with the {@link }
32. * ezcCacheManager}, a class implementing this interface is necessary. The name
33. * of the class must be stored in the {@link ezcCacheStackOptions} defined for
34. * the stack in the manager. As soon as the stack is requested by the user for
35. * the first time, a new {@link ezcCacheStack} object will be created in the
36. * manager. This object will be given to the {@link }
37. * ezcCacheStackConfigurator->configure()} method of the class named in the
38. * options.
39. *
40. * @package Cache
41. * @version //autogentag//
42. */
43. interface ezcCacheStackConfigurator
44. {
45. /**
46. * Configures the given stack.
47. *
48. * This method configures the given $stack object. The object is usually
49. * expected to be newly constructed after this method receives it. If given
50. * in a class implemnting this interface is given in {@link }
51. * ezcCacheStackOptions}, this method will be called automatically from
52. * {@link ezcCacheStack->__construct()}.
53. *
54. * This method is expected to use the {@link ezcCacheStack->pushStorage()}
55. * method to configure storages in the stack.
56. *
57. * @param ezcCacheStack $stack
58. * @return void
59. */
60. public static function configure ( ezcCacheStack $stack );
61. }
63. ?>

Documentation generated by phpDocumentor 1.4.3