Zend Framework: Zend_Config_Yaml Component Proposal

Table of Contents

1. Overview

Zend_Config_Yaml implements YAML markup support for Zend_Config reading and writing.

2. References

• YAML

3. Component Requirements, Constraints, and Acceptance Criteria

• This component will allow Zend_Config users to read and write YAML configuration files
• This component will allow to use pluggable YAML parser/generator, since there's no standard Zend_Yaml component for now.
• This component will support configuration sections.
• This component will support single inheritance of configuration sections.

4. Dependencies on Other Framework Components

• Zend_Config
• Zend_Config_Exception

5. Theory of Operation

The component will allow to read and write configuration files in YAML format. Built-in parser will support only the simple subset of YAML, but external parsers (such as syck or spyc) can be plugged in for more complex formats.

6. Milestones / Tasks

• Milestone 1: [DONE] Create the spec for YAML support in Zend_Config
• Milestone 2: [DONE] Working code checked into the lab
• Milestone 3: [DONE] Parser unit tests checked into the lab
• Milestone 4: Writer unit tests checked into the lab
• Milestone 5: Proposal accepted
• Milestone 6: Documentation for the component exists
• Milestone 7: Code checked into the trunk

7. Class Index

• Zend_Config_Yaml
• Zend_Config_Writer_Yaml

8. Use Cases

9. Class Skeletons