Adding documentation about the simple cache PSR-16 implementation #7417
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
weaverryan
commented
Jan 26, 2017
| Key Concepts | ||
| ------------ | ||
| Cache (PSR-6) Versus Simple Cache (PSR-16) | ||
| ------------------------------------------ |
There was a problem hiding this comment.
@nicolas-grekas Is this small section accurate? Everything else is straightforward - I just wanted you to check this one spot! Thanks!
components/cache.rst
Outdated
|
|
||
| .. tip:: | ||
|
|
||
| To find out more about each of these classes, you can read th |
components/cache/cache_pools.rst
Outdated
|
|
||
| $fileCache = new FilesystemAdapter(); | ||
|
|
||
| $cache = new TraceableAdapter(array($fileCache)); |
8000
components/cache.rst
Outdated
|
|
||
| .. toctree:: | ||
| :glob: | ||
| :maxdepth: 1 | ||
|
|
||
| cache/* | ||
|
|
||
| .. _cache-component-psr16-caching: | ||
|
|
||
| Simple Caching (PSR-16) |
There was a problem hiding this comment.
I'd move the simple cache part (PSF-16) before the complex cache part (PSR-6). That's the usual practice in docs: simple first and then build up to complex.
components/cache.rst
Outdated
|
|
||
| This part of the component is an implementation of `PSR-16`_, which means that its | ||
| basic API is the same as defined in the standard. First, create a cache object from | ||
| one of the built-in cache clases. For example, to create a filesystem-based cache, |
components/cache/cache_pools.rst
Outdated
| @@ -5,8 +5,8 @@ | |||
| single: Redis Cache | |||
| single: PDO Cache, Doctrine DBAL Cache | |||
|
|
|||
| Cache Pools | |||
| =========== | |||
| Cache Pools & Supported Adapters | |||
components/cache/cache_pools.rst
Outdated
| 'memcached://user:pass@localhost?weight=33', | ||
|
|
||
| // options, including username, password and Memcached::OPT_* options | ||
| ['persistent_id' => '_products_cache'] |
components/cache/cache_pools.rst
Outdated
| // options, including username, password and Memcached::OPT_* options | ||
| ['persistent_id' => '_products_cache'] | ||
| ); | ||
| $memcachedClient = MemcachedAdapter::createConnection([ |
There was a problem hiding this comment.
And here too, long array syntax
javiereguiluz
requested changes
Jan 27, 2017
|
Feedback applied! And I added the last section about converting between the 2 caches Status: Needs Review |
components/cache.rst
Outdated
| // $numProducts = $cache->get('stats.num_products', 100); | ||
|
|
||
| // remove the cache key | ||
| $cache->deleteItem('stats.num_products'); |
There was a problem hiding this comment.
deleteItem() should be delete() ?
components/cache/cache_pools.rst
Outdated
| // options, including username, password and Memcached::OPT_* options | ||
| array('persistent_id' => '_products_cache') | ||
| ); | ||
| $memcachedClient = MemcachedAdapter::createConnection(array( |
There was a problem hiding this comment.
Is this repeated $memcachedClient variable defined on purpose? Should we merge its contents with the previous variable?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi guys!
This covers #7409!
Cheers!