RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-01-26 10:01:45 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1096 from simonharris/master

Browse Source 
Changes for grammar and clarity
This commit is contained in:
Marco Pivetta 2014-07-31 18:02:34 +02:00
commit 2ae8538f96
1 changed files with 36 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
docs/en/reference/caching.rst
View File

@ -4,9 +4,9 @@ Caching
Doctrine provides cache drivers in the ``Common`` package for some Doctrine provides cache drivers in the ``Common`` package for some
of the most popular caching implementations such as APC, Memcache of the most popular caching implementations such as APC, Memcache
and Xcache. We also provide an ``ArrayCache`` driver which stores and Xcache. We also provide an ``ArrayCache`` driver which stores
the data in a PHP array. Obviously, the cache does not live between the data in a PHP array. Obviously, when using ``ArrayCache``, the
requests but this is useful for testing in a development cache does not persist between requests, but this is useful for
environment. testing in a development environment.
Cache Drivers Cache Drivers
------------- -------------
@ -14,20 +14,19 @@ Cache Drivers
The cache drivers follow a simple interface that is defined in The cache drivers follow a simple interface that is defined in
``Doctrine\Common\Cache\Cache``. All the cache drivers extend a ``Doctrine\Common\Cache\Cache``. All the cache drivers extend a
base class ``Doctrine\Common\Cache\AbstractCache`` which implements base class ``Doctrine\Common\Cache\AbstractCache`` which implements
the before mentioned interface. this interface.
The interface defines the following methods for you to publicly The interface defines the following public methods for you to implement:
use.
- fetch($id) - Fetches an entry from the cache. - fetch($id) - Fetches an entry from the cache
- contains($id) - Test if an entry exists in the cache. - contains($id) - Test if an entry exists in the cache
- save($id, $data, $lifeTime = false) - Puts data into the cache. - save($id, $data, $lifeTime = false) - Puts data into the cache
- delete($id) - Deletes a cache entry. - delete($id) - Deletes a cache entry
Each driver extends the ``AbstractCache`` class which defines a few Each driver extends the ``AbstractCache`` class which defines a few
abstract protected methods that each of the drivers must abstract protected methods that each of the drivers must
implement. implement:
- \_doFetch($id) - \_doFetch($id)
@ -35,8 +34,8 @@ implement.
- \_doSave($id, $data, $lifeTime = false) - \_doSave($id, $data, $lifeTime = false)
- \_doDelete($id) - \_doDelete($id)
The public methods ``fetch()``, ``contains()``, etc. utilize the The public methods ``fetch()``, ``contains()`` etc. use the
above protected methods that are implemented by the drivers. The above protected methods which are implemented by the drivers. The
code is organized this way so that the protected methods in the code is organized this way so that the protected methods in the
drivers do the raw interaction with the cache implementation and drivers do the raw interaction with the cache implementation and
the ``AbstractCache`` can build custom functionality on top of the ``AbstractCache`` can build custom functionality on top of
@ -65,7 +64,7 @@ Memcache
In order to use the Memcache cache driver you must have it compiled In order to use the Memcache cache driver you must have it compiled
and enabled in your php.ini. You can read about Memcache and enabled in your php.ini. You can read about Memcache
` on the PHP website <http://php.net/memcache>`_. It will `on the PHP website <http://php.net/memcache>`_. It will
give you a little background information about what it is and how give you a little background information about what it is and how
you can use it as well as how to install it. you can use it as well as how to install it.
@ -90,7 +89,7 @@ Memcache.
In order to use the Memcached cache driver you must have it compiled In order to use the Memcached cache driver you must have it compiled
and enabled in your php.ini. You can read about Memcached and enabled in your php.ini. You can read about Memcached
` on the PHP website <http://php.net/memcached>`_. It will `on the PHP website <http://php.net/memcached>`_. It will
give you a little background information about what it is and how give you a little background information about what it is and how
you can use it as well as how to install it. you can use it as well as how to install it.
@ -129,10 +128,10 @@ Redis
~~~~~ ~~~~~
In order to use the Redis cache driver you must have it compiled In order to use the Redis cache driver you must have it compiled
and enabled in your php.ini. You can read about what is Redis and enabled in your php.ini. You can read about what Redis is
`from here <http://redis.io/>`_. Also check `from here <http://redis.io/>`_. Also check
`A PHP extension for Redis <https://github.com/nicolasff/phpredis/>`_ for how you can use `A PHP extension for Redis <https://github.com/nicolasff/phpredis/>`_ for how you can use
and install Redis PHP extension. and install the Redis PHP extension.
Below is a simple example of how you could use the Redis cache Below is a simple example of how you could use the Redis cache
driver by itself. driver by itself.
@ -151,8 +150,8 @@ Using Cache Drivers
------------------- -------------------
In this section we'll describe how you can fully utilize the API of In this section we'll describe how you can fully utilize the API of
the cache drivers to save cache, check if some cache exists, fetch the cache drivers to save data to a cache, check if some cached data
the cached data and delete the cached data. We'll use the exists, fetch the cached data and delete the cached data. We'll use the
``ArrayCache`` implementation as our example here. ``ArrayCache`` implementation as our example here.
.. code-block:: php .. code-block:: php
@ -163,7 +162,7 @@ the cached data and delete the cached data. We'll use the
Saving Saving
~~~~~~ ~~~~~~
To save some data to the cache driver it is as simple as using the Saving some data to the cache driver is as simple as using the
``save()`` method. ``save()`` method.
.. code-block:: php .. code-block:: php
@ -172,7 +171,7 @@ To save some data to the cache driver it is as simple as using the
$cacheDriver->save('cache_id', 'my_data'); $cacheDriver->save('cache_id', 'my_data');
The ``save()`` method accepts three arguments which are described The ``save()`` method accepts three arguments which are described
below. below:
- ``$id`` - The cache id - ``$id`` - The cache id
@ -195,7 +194,7 @@ object, etc.
Checking Checking
~~~~~~~~ ~~~~~~~~
Checking whether some cache exists is very simple, just use the Checking whether cached data exists is very simple: just use the
``contains()`` method. It accepts a single argument which is the ID ``contains()`` method. It accepts a single argument which is the ID
of the cache entry. of the cache entry.
@ -213,7 +212,7 @@ Fetching
Now if you want to retrieve some cache entry you can use the Now if you want to retrieve some cache entry you can use the
``fetch()`` method. It also accepts a single argument just like ``fetch()`` method. It also accepts a single argument just like
``contains()`` which is the ID of the cache entry. ``contains()`` which is again the ID of the cache entry.
.. code-block:: php .. code-block:: php
@ -249,7 +248,7 @@ the ``deleteAll()`` method.
Namespaces Namespaces
~~~~~~~~~~ ~~~~~~~~~~
If you heavily use caching in your application and utilize it in If you heavily use caching in your application and use it in
multiple parts of your application, or use it in different multiple parts of your application, or use it in different
applications on the same server you may have issues with cache applications on the same server you may have issues with cache
naming collisions. This can be worked around by using namespaces. naming collisions. This can be worked around by using namespaces.
@ -265,8 +264,8 @@ Integrating with the ORM
------------------------ ------------------------
The Doctrine ORM package is tightly integrated with the cache The Doctrine ORM package is tightly integrated with the cache
drivers to allow you to improve performance of various aspects of drivers to allow you to improve the performance of various aspects of
Doctrine by just simply making some additional configurations and Doctrine by simply making some additional configurations and
method calls. method calls.
Query Cache Query Cache
@ -374,9 +373,9 @@ the cache driver.
Clearing the Cache Clearing the Cache
------------------ ------------------
We've already shown you previously how you can use the API of the We've already shown you how you can use the API of the
cache drivers to manually delete cache entries. For your cache drivers to manually delete cache entries. For your
convenience we offer a command line task for you to help you with convenience we offer a command line task to help you with
clearing the query, result and metadata cache. clearing the query, result and metadata cache.
From the Doctrine command line you can run the following command. From the Doctrine command line you can run the following command.
@ -408,7 +407,7 @@ To clear the result cache use the ``--result`` option.
$ ./doctrine clear-cache --result $ ./doctrine clear-cache --result
When you use the ``--result`` option you can use some other options When you use the ``--result`` option you can use some other options
to be more specific about what queries result sets you want to to be more specific about which queries' result sets you want to
clear. clear.
Just like the API of the cache drivers you can clear based on an Just like the API of the cache drivers you can clear based on an
@ -418,19 +417,19 @@ ID, regular expression, prefix or suffix.
$ ./doctrine clear-cache --result --id=cache_id $ ./doctrine clear-cache --result --id=cache_id
Or if you want to clear based on a regular expressions. Or if you want to clear based on a regular expressions:
.. code-block:: php .. code-block:: php
$ ./doctrine clear-cache --result --regex=users_.* $ ./doctrine clear-cache --result --regex=users_.*
Or with a prefix. Or with a prefix:
.. code-block:: php .. code-block:: php
$ ./doctrine clear-cache --result --prefix=users_ $ ./doctrine clear-cache --result --prefix=users_
And finally with a suffix. And finally with a suffix:
.. code-block:: php .. code-block:: php
@ -447,15 +446,15 @@ And finally with a suffix.
Cache Slams Cache Slams
----------- -----------
Something to be careful of when utilizing the cache drivers is Something to be careful of when using the cache drivers is
cache slams. If you have a heavily trafficked website with some "cache slams". Imagine you have a heavily trafficked website with some
code that checks for the existence of a cache record and if it does code that checks for the existence of a cache record and if it does
not exist it generates the information and saves it to the cache. not exist it generates the information and saves it to the cache.
Now if 100 requests were issued all at the same time and each one Now, if 100 requests were issued all at the same time and each one
sees the cache does not exist and they all try and insert the same sees the cache does not exist and they all try to insert the same
cache entry it could lock up APC, Xcache, etc. and cause problems. cache entry it could lock up APC, Xcache, etc. and cause problems.
Ways exist to work around this, like pre-populating your cache and Ways exist to work around this, like pre-populating your cache and
not letting your users requests populate the cache. not letting your users' requests populate the cache.
You can read more about cache slams You can read more about cache slams
`in this blog post <http://notmysock.org/blog/php/user-cache-timebomb.html>`_. `in this blog post <http://notmysock.org/blog/php/user-cache-timebomb.html>`_.