The Proem framework aims to be a lightweight, simple & fast MVC implementation built on top of PHP5.4
The overall design has been kicking around my head for a number of years, slowly becoming more and more refined over time. This is actually the third iteration of the idea.
The current idea sees the framework become Event driven, with the Bootstrap process executing a filter chain to instantiate the bulk of the components required to build an application. During the execution of each step in the filter chain, events are triggered exposing the ability to customise this process.
The project currently consists of this website, http://proemframework.org, an irc channel on #proem irc.freenode.net, and our issue tracker and code repositories on GitHub.
Please be aware that while this documentation is accurate at the time of writing, Proem is a fast moving target at this point in time.
Complete and absolute name space paths are used throughout the Proem documentation for clarity. In the real world, you would use shorter aliased names.
Proem is still very much in early pre-alpha stages and should be considered under heavy development. While writing this documentation I have made a best effort to ensure that all code examples are tested. However, there are parts of the documentation where features that are not currently available are made mention of. Where this occurs, it is also mentioned that these features are "planned" or "soon to be worked on". In some cases issues are also linked to within the Issue Tracker
The menu on the left follows a path that means reading each of the pages linked to from top to bottom should progress through the frameworks functionality in a reasonably linear fashion. The menu has been split into three distinct sections:
This section contains guides designed to give you a high level view of how things work, as well as detailed information about the Bootstrap process.
Installation is a fairly obvious first step, the Quick Start Guide then guides you through building a very simple application without going into too much detail before The Bootstrap Process walks you through a first introduction to the Proem internals and how the framework is held together.
In this section each of the components within the framework are described in further detail. These pages could likely be looked at more as a reference than a guide but reading these will give you a thorough understanding of the framework and how to make the most of the functionality it provides.
The Userland section covers how you can write code to extend and build upon the Proem framework.
If you are then still looking for more detail we also have available the API Documentation. This documentation documents every class and method within Proem and is automatically generated from comments within the actual code itself.
If you find any bugs in the documentation, please report them at https://github.com/proem/proem/issues.