Zend Framework: Zend_Vfs Component Proposal

Table of Contents

1. Overview

Zend_Vfs is the representation of a Virtual File System. It is virtual because it simulates a normal file system by using one of the many available adapters. An adapter is the communication layer between the Virtual File System and the storage device. The storage device can be the file system itself, a database, etc.

2. References

• http://en.wikipedia.org/wiki/Virtual_file_system

3. Component Requirements, Constraints, and Acceptance Criteria

• This component will implement CRUD operations for directories.
• This component will implement CRUD operations for files.

4. Dependencies on Other Framework Components

• SPL
• Zend_Date
• Zend_Db

5. Theory of Operation

Some ideas for adapters are the following:

• FileSystem; This adapter will act on the underlying file system.
• Database; This adapter will store the files and directories in a database. This will probably work with Zend_Db
• FTP; This adapter can communicate with an FTP server.

6. Milestones / Tasks

• Milestone 1: Setup the proposal and consider feedback.
• Milestone 2: Write and finish component source code.
• Milestone 3: Write unit tests
• Milestone 4: Write documentation

7. Class Index

• \Zend\Vfs\Directory
• \Zend\Vfs\DirectoryNotFoundException
• \Zend\Vfs\File
• \Zend\Vfs\FileNotFoundException
• \Zend\Vfs\Vfs
• \Zend\Vfs\Adapter\AbstractAdapter
• \Zend\Vfs\Adapter\FileSystem

8. Use Cases

9. Class Skeletons

The code for this proposal can be found at https://github.com/WalterTamboer/zf2/tree/master/library/Zend/Vfs