Zend Framework: Zend_CodeGenerator_Apache Component Proposal

Table of Contents

1. Overview

Zend_CodeGenerator_Apache is a subset of Zend_CodeGenerator which deals with reading and writing existing and new apache-style configuration files.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

• This component will be able to parse existing Apache configuration files into a PHP object structure representing the file
• This component will NOT validate the proper relationships of Apache configuration directives (e.g. validating context restrictions)
• This component will be able to write the PHP object representation of an Apache configuration file back to disk
• This component may (but probably won't) accept input via XML or a Zend_Config object

4. Dependencies on Other Framework Components

• Zend_Exception

5. Theory of Operation

This component may be instantiated using it's normal constructor and built up programmatically
This component may be instantiated using a fromString() method to start with an existing file

6. Milestones / Tasks

• Milestone 1: design notes will be published here
• Milestone 2: Working prototype for exiting file parsing
• Milestone 3: Working prototype creating files from scratch
• Milestone 4: Unit tests exist, work, and are checked into SVN.
• Milestone 5: Initial documentation exists.

7. Class Index

• Zend_CodeGenerator_Apache_Abstract
• Zend_CodeGenerator_Apache_Block
• Zend_CodeGenerator_Apache_Comment
• Zend_CodeGenerator_Apache_Context
• Zend_CodeGenerator_Apache_Definition
• Zend_CodeGenerator_Apache_Directive
• Zend_CodeGenerator_Apache_Exception
• Zend_CodeGenerator_Apache_File
• Zend_CodeGenerator_Apache_Item

8. Use Cases

9. Class Skeletons