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
New Proposal Template
This page has been created from a template that uses "zones." To proceed:
  1. Edit the page
  2. Replace sample content within each zone-data tag with your own content
  3. Remove this notice
  4. Save the page
  5. When you are ready for community review, move this page to the Ready for Review section on the edit page.
No placeholders allowed!
Please do not create placeholders. Wait until you have sufficient content to replace all sample data in the proposal template before creating your proposal document.

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

Zend Framework: Zend\Cache Component Proposal

Proposed Component Name Zend\Cache
Developer Notes http://framework.zend.com/wiki/display/ZFDEV/Zend\Cache
Proposers Marc Bennewitz
Pádraic Brady ?
Zend Liaison TBD
Revision 1.0 - 7 March 2010: Initial Draft. (wiki revision: 12)

Table of Contents

1. Overview

The current Zend_Cache component is very inflexible with it's Frontend/Backend structure. It's not possible to merge different frontens together (e.g. MasterFile and Page cache). Furthermore, few advantages of some cache storage systems are not derived by Zend_Cache. E.g. some storage systems can handle different data-types but Zend_Cache only permit strings.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

TODO
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

Global:

  • Zend\Loader\PluginLoader
  • Zend\Exception

Zend\Serializer

  • Storage\Plugin\Serialize

Zend\Filter

  • Storage\Plugin\Filter
  • Storage\Plugin\KeyFilter

See: http://github.com/marc-mabe/zf2-cache

5. Theory of Operation

Storage Adapter:
The storage adapters are classes of wrappers of the existing storage engines usable for caching (Memcache, Database, Filesystem ...).
They all implement an interface to get a consistent API but only reflect supported facilities of the used storage engine.

Storage Plugins:
Precisely because the storage adapters supports different facilities you can add facilities belated with the storage plugins.
(e.g. tag support, automatic serialize). The storage plugins have the same API as the storage adapters and therefor implement
an interface extending the adapters interface. Where ever a storage adapter is required you can set an instance of a storage plugin and you can merge all storage plugins as you like. The storage plugins self don't store any data - they need a storage adapter as storage engine.

A special storage plugin is the base storage class (Zend\Cache\Storage). It implements additional methods for simpler handling lists of
plugins within the own object.

Special Cache Patterns:
Some special cache patterns shouldn't use the standard cache API. They are: Output, Page, Function, Class, Callback and Capture.
These caches only implement a very simple pattern interface which only defines how options have to be set.

6. Milestones / Tasks

  • Milestone 1: Finish proposal
  • Milestone 2: Working prototype
  • Milestone 3: Prototype checked into the incubator
  • Milestone 4: Unit tests exist finished and component is working
  • Milestone 5: Initial documentation exists
  • Milestone 6: Changed related components
  • Milestone 7: Moved to core.

7. Class Index

Storage Adapter:

  • namespace Zend\Cache\Storage
  • interface Adaptable
  • abstract Adapter\AbstractAdapter implements Adaptable
  • class Adapter\Memory extends Adapter\AbstractAdapter
  • class Adapter\Memcached extends Adapter\AbstractAdapter
  • class Adapter\Apc extends Adapter\AbstractAdapter
  • class Adapter\WinCache extends Adapter\AbstractAdapter
  • class Adapter\Xcache extends Adapter\AbstractAdapter
  • class Adapter\ZendServerShm extends Adapter\AbstractAdapter
  • class Adapter\ZendServerDisk extends Adapter\AbstractAdapter
  • class Adapter\ZendPlatform extends Adapter\AbstractAdapter
  • class Adapter\Database extends Adapter\AbstractAdapter
  • class Adapter\Filesystem extends Adapter\AbstractAdapter

Storage Plugins:

  • namespace Zend\Cache\Storage
  • interface Pluggable extends Adaptable
  • abstract Plugin\AbstractPlugin implements Pluggable
  • class BlackHole extends Plugin\AbstractPlugin
  • class ClearByFactor extends Plugin\AbstractPlugin
  • class ExceptionHandler extends Plugin\AbstractPlugin
  • class Filter extends Plugin\AbstractPlugin
  • class IgnoreUserAbort extends Plugin\AbstractPlugin
  • class KeyFilter extends Plugin\AbstractPlugin
  • class Levels extends Plugin\AbstractPlugin
  • class MasterFile extends Plugin\AbstractPlugin
  • class OptimizeByFactor extends Plugin\AbstractPlugin
  • class Reluctant extends Plugin\AbstractPlugin
  • class Serialize extends Plugin\AbstractPlugin
  • class Prefix extends Plugin\AbstractPlugin
  • class Serialize extends Plugin\AbstractPlugin
  • class StoreTimes extends Plugin\AbstractPlugin
  • class Tagging extends Plugin\AbstractPlugin
  • class WriteControl extends Plugin\AbstractPlugin
  • use \Zend\Cache
  • class Cache\Storage extends Plugin\AbstractPlugin

Special Cache Patterns:

  • namesapce Zend\Cache
  • interface Pattern\PatternInterface (TODO)
  • abstract Pattern\AbstractPattern implements Pattern\PatternInterface
  • class Pattern\CallbackCache extends Pattern\AbstractPattern
  • class Pattern\ClassCache extends Pattern\AbstractPattern
  • class Pattern\FunctionCache extends Pattern\AbstractPattern
  • class Pattern\OutputCache extends Pattern\AbstractPattern
  • class Pattern\PageCache extends Pattern\AbstractPattern
  • class Pattern\CaptureCache extends Pattern\AbstractPattern
  • use \Zend\Cache
  • class Cache\Pattern (PatternFactory)

Manager:

  • namesapce Zend\Cache
  • class Manager

Exceptions:

  • namesapce Zend\Cache
  • interface Exception extends \Zend\Exception
  • class RuntimeException extends \InvalidArgumentException implements Exception
  • class InvalidArgumentException extends \InvalidArgumentException implements Exception
  • class UnexpectedValueException extends \UnexpectedValueException implements Exception
  • class LoaderException extends \Exception implements Exception
  • class BadMethodCallException extends \BadMethodCallException implements Exception

8. Use Cases

9. Class Skeletons

]]></ac:plain-text-body></ac:macro>

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