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

<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.
2.0 - 17 Jun 2010: finish proposal (wiki revision: 23)

Table of Contents

1. Overview

The current Zend_Cache component is very inflexible with it's Frontend/Backend structure. For example it's not possible to merge different frontends 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.

The most of the open issues are related to this structure and should be solved with ZF 2.0 by this proposal.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will break bc 100% !!!!!
  • This components will read & write data from cache storage engines using only one adapter interface.
  • Adapters will not implement special functionalities directly to the storage engines (like serialization) to keep performance
    but implements a plugin structure to dynamically add/configure/re-order such functionalities.
  • Plugins will not store any data directly to a storage engine - a real storage adapter have to be used.
  • This component will add some special cache patterns using a different API (like PageCache, CaptureCache).

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

5. Theory of Operation

Storage Adapter:
The storage adapters are classes of wrappers of the existing storage engines usable for caching (Memcached, 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 real 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 it's own instance.

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

In case of the capture pattern it no longer needs the "Static" storage adapter (or old named backend) because the storage is very specific and only usable with the capture pattern and vise versa. Therefore the capture pattern will implement reading/writing files within it's self.

6. Milestones / Tasks

  • Milestone 1: [DONE] Finish proposal
  • Milestone 2: [DONE] Working prototype
  • Milestone 3: Unit tests exist finished and component is working
  • Milestone 4: Initial documentation exists
  • Milestone 5: Changed related components
  • Milestone 6: Moved to core.

7. Class Index

Storage Adapter:

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

Storage Plugins:

  • namespace Zend\Cache\Storage\Plugin (use Zend\Cache\Storgae)
  • interface Storage\Plugin extends Storage\Adapter
  • abstract AbstractPlugin implements Storage\Plugin
  • class ClearByFactor extends AbstractPlugin
  • class ExceptionHandler extends AbstractPlugin (Callback on exception + logging)
  • class Filter extends AbstractPlugin
  • class IgnoreUserAbort extends AbstractPlugin
  • class KeyFilter extends AbstractPlugin
  • class Levels extends AbstractPlugin
  • class MasterFile extends AbstractPlugin
  • class OptimizeByFactor extends AbstractPlugin
  • class Reluctant extends AbstractPlugin
  • class Serialize extends AbstractPlugin
  • class Prefix extends AbstractPlugin
  • class StoreTimes extends AbstractPlugin
  • class Tagging extends AbstractPlugin
  • class WriteControl extends AbstractPlugin
  • namespace \Zend\Cache
  • class Storage extends Storage\Plugin\AbstractPlugin
  • class StorageFactory

Special Cache Patterns:

  • namesapce Zend\Cache\Pattern (use Zend\Cache)
  • abstract AbstractPattern implements Cache\Pattern
  • class CallbackCache extends AbstractPattern (Function and Callback calls)
  • class ClassCache extends AbstractPattern (only static method calls)
  • class ObjectCache extends AbstractPattern (only object method calls)
  • class OutputCache extends AbstractPattern
  • class PageCache extends AbstractPattern
  • class CaptureCache extends AbstractPattern
  • namespace \Zend\Cache
  • interface Pattern
  • class 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.