Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History
Under Construction
This proposal is under construction and is not ready for review.

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Acl_Controller_Plugin_Acl Component Proposal

Proposed Component Name Zend_Acl_Controller_Plugin_Acl
Developer Notes
Proposers Aldemar Bernal
Revision 1.0 - 14 November 2007: Proposal created. (wiki revision: 5)

Table of Contents

1. Overview

Zend_Acl_Controller_Plugin_Acl is a Front Controller plug in that allows to grant or deny access to the application based on ACL.

2. References

  • [Zend_Acl documentation]
  • [Zend_Controller Plugin documentation]

3. Component Requirements, Constraints, and Acceptance Criteria

Most requirements take the form of "foo will do ...." or "foo will not support ...", although different words and sentence structure might be used. Adding functionality to your proposal is requirements creep (bad), unless listed below. Discuss major changes with your team first, and then open a "feature improvement" issue against this component.

  • This component will correctly reads a developers mind for intent and generate the right configuration file.
  • The generated config file will not support XML, but will provide an extension point in the API.
  • This component will use no more memory than twice the size of all data it contains.
  • This component will include a factory method.
  • This component will not allow subclassing. (i.e. when reviewed, we expect to see "final" keyword in code)
  • This component will only generate data exports strictly complying with RFC 12345.
  • This component will validate input data against formats supported by ZF component Foo.
  • This component will not save any data using Zend_Cache or the filesystem. All transient data will be saved using Zend_Session.

4. Dependencies on Other Framework Components

  • Zend_Acl
  • Zend_Config
  • Zend_Controller_Front
  • Zend_Acl_Exception
  • simplexml

5. Theory of Operation

This class can be instantiated using an ACL object, a Zend Config object or a XML string, this object (that will be converted to a Zend_Acl) must have a role (which name can be configurated on the plugin) and the allowed/denied operations (module/controller/view combination). After created it must be registered as a Front Controller Plugin

6. Milestones / Tasks

  • Milestone 1: Create ZF Wiki info.
  • Milestone 2: Working prototype and some examples
  • Milestone 3: Working prototype checked into the incubator supporting use cases.
  • Milestone 4: Unit tests exist, work, and are checked into SVN.
  • Milestone 5: Initial documentation exists.

If a milestone is already done, begin the description with "[DONE]", like this:

  • Milestone #: [DONE] Unit tests ...

7. Class Index

  • Zend_Acl_Controller_Plugin_Acl

8. Use Cases


... (see good use cases book)

9. Class Skeletons


Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.