Merge pull request FriendsOfSymfony#454 from FriendsOfSymfony/support-autowiring

support symfony 4 autowiring and adjust doc to autowiring

Author: dbu

CHANGELOG.md

@@ -1,5 +1,20 @@
 Changelog
 =========
+
+2.4.0 (unreleased)
+------------------
+
+### Added
+
+* Autowiring support for the services in this bundle:
+
+ - fos_http_cache.cache_manager => FOS\HttpCacheBundle\CacheManager
+ - fos_http_cache.http.symfony_response_tagger => FOS\HttpCacheBundle\Http\SymfonyResponseTagger
+ - fos_http_cache.event_listener.cache_control => FOS\HttpCacheBundle\EventListener\CacheControlListener
+ - fos_http_cache.proxy_client.default => FOS\HttpCache\ProxyClient\ProxyClient
+
+ The old service names are still available, but using them directly is deprecated.
+
 2.3.1
 -----
 

Resources/doc/features/helpers/flash-message.rst

@@ -53,7 +53,7 @@ to only show the flash message once. Something along these lines:
 
  function showFlash()
  {
- var cookie = getCookie("flashes"); // fos_http_cache.flash_message.name
+ var cookie = getCookie("flashes"); // you can change the cookie name in fos_http_cache.flash_message.name configuration option
 
  if (!cookie) {
  return;
@@ -73,7 +73,7 @@ to only show the flash message once. Something along these lines:
  // YOUR WORK: show flashes in your DOM...
 
  // remove the cookie to not show flashes again
- // path is the fos_http_cache.flash_message.path value
+ // the cookie path is controlled by the fos_http_cache.flash_message.path configuration option
  document.cookie = "flashes=; expires=Thu, 01 Jan 1970 00:00:01 GMT; path=/";
  }
 

Resources/doc/features/invalidation.rst

@@ -35,7 +35,9 @@ To invalidate single paths, URLs and routes manually, use the
 ``invalidatePath($path, $headers)`` and ``invalidateRoute($route, $params, $headers)`` methods on
 the cache manager::
 
- $cacheManager = $container->get('fos_http_cache.cache_manager');
+ use FOS\HttpCacheBundle\CacheManager;
+
+ $cacheManager = $container->get(CacheManager::class);
 
  // Invalidate a path
  $cacheManager->invalidatePath('/users')->flush();

Resources/doc/features/symfony-http-cache.rst

@@ -69,6 +69,7 @@ The :ref:`FOSHttpCache Symfony Proxy Client documentation section <foshttpcache:
 explains how to adjust your bootstrap - you will need to do this in both
 ``public/index.php`` and ``bin/console``.
 
-Once your bootstrapping is adjusted, set ``fos_http_cache.proxy_client.symfony.use_kernel_dispatcher: true``.
+Once your bootstrapping is adjusted, set the configuration option
+``fos_http_cache.proxy_client.symfony.use_kernel_dispatcher: true``.
 
 .. _Symfony HttpCache documentation: http://symfony.com/doc/current/book/http_cache.html#symfony-reverse-proxy

Resources/doc/features/tagging.rst

@@ -52,29 +52,26 @@ invalidation requests are flushed to the caching proxy
 Tagging and Invalidating from PHP Code
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To add tags to responses, inject the ``ResponseTagger`` (service
-``fos_http_cache.http.symfony_response_tagger``) and use ``addTags($tags)`` to
-add tags that will be set on the response::
+To add tags to responses, use the ``ResponseTagger::addTags`` method::
 
  use FOS\HttpCacheBundle\Http\SymfonyResponseTagger;
 
  class NewsController
  {
- /**
- * @var SymfonyResponseTagger
- */
- private $responseTagger;
-
- public function articleAction($id)
+ public function articleAction(string $id, SymfonyResponseTagger $responseTagger)
  {
- $this->responseTagger->addTags(array('news', 'news-' . $id));
+ $responseTagger->addTags(array('news', 'news-' . $id));
 
  // ...
  }
  }
 
-To invalidate tags, inject the ``CacheManager`` (service ``fos_http_cache.cache_manager``)
-and call ``invalidateTags($tags)`` on it::
+.. versionadded:: 2.3.2
+ Autowiring support has been added in version 2.3.2. In older versions of
+ the bundle, you need to inject the service
+ ``fos_http_cache.http.symfony_response_tagger`` into your controller.
+
+To invalidate tags, use the ``CacheManager::invalidateTags($tags)`` method::
 
  use FOS\HttpCacheBundle\CacheManager;
 
@@ -85,16 +82,21 @@ and call ``invalidateTags($tags)`` on it::
  */
  private $cacheManager;
 
- public function editAction($id)
+ public function editAction(string $id, CacheManager $cacheManager)
  {
  // ...
 
- $this->cacheManager->invalidateTags(array('news-' . $id));
+ $cacheManager->invalidateTags(array('news-' . $id));
 
  // ...
  }
  }
 
+.. versionadded:: 2.3.2
+ Autowiring support has been added in version 2.3.2. In older versions of
+ the bundle, you need to inject the service ``fos_http_cache.cache_manager``
+ in your controller.
+
 Tagging from Twig Templates
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

Resources/doc/reference/cache-manager.rst

@@ -15,6 +15,14 @@ By *refreshing* a piece of content, a fresh copy will be fetched right away.
  These terms are explained in more detail in
  :ref:`An Introduction to Cache Invalidation <foshttpcache:invalidation introduction>`.
 
+The cache manager is available in the Symfony DI container using autowiring
+with the ``FOS\HttpCacheBundle\CacheManager`` class.
+
+.. versionadded:: 2.3.2
+ Autowiring support has been added in version 2.3.2. In older versions of
+ the bundle, you need to explicitly use the service name
+ ``fos_http_cache.cache_manager``.
+
 .. _cache manager invalidation:
 
 ``invalidatePath()``
@@ -38,12 +46,10 @@ Invalidate a URL::
 
 Invalidate a route::
 
- $cacheManager = $container->get('fos_http_cache.cache_manager');
  $cacheManager->invalidateRoute('user_details', array('id' => 123));
 
 Invalidate a :ref:`regular expression <foshttpcache:invalidate regex>`::
 
- $cacheManager = $container->get('fos_http_cache.cache_manager');
  $cacheManager->invalidateRegex('.*', 'image/png', array('example.com'));
 
 The cache manager offers a fluent interface::
@@ -67,17 +73,14 @@ The cache manager offers a fluent interface::
 
 Refresh a path::
 
- $cacheManager = $container->get('fos_http_cache.cache_manager');
  $cacheManager->refreshPath('/users');
 
 Refresh a URL::
 
- $cacheManager = $container->get('fos_http_cache.cache_manager');
  $cacheManager->refreshPath('http://www.example.com/users');
 
 Refresh a Route::
 
- $cacheManager = $container->get('fos_http_cache.cache_manager');
  $cacheManager->refreshRoute('user_details', array('id' => 123));
 
 .. _cache_manager_tags:

Resources/doc/reference/configuration/headers.rst

@@ -134,9 +134,11 @@ directive. This is the default value for the cache control and there is no
 way to determine if it was manually set. If the full header is only
 ``no-cache``, the whole cache control is overwritten.
 
-You can prevent the cache control on specific requests by injecting the
-service ``fos_http_cache.event_listener.cache_control`` and calling
-``setSkip()`` on it. If this method is called, no cache rules are applied.
+You can prevent the cache control on specific controller actions by calling
+``FOS\HttpCacheBundle\EventListener\CacheControlListener::setSkip()``. When
+skip is set to ``true``, no cache rules are applied. This service can be
+autowired - in older versions of the bundle, use the service
+``fos_http_cache.event_listener.cache_control``.
 
 ``cache_control``
 """""""""""""""""

Resources/doc/reference/configuration/proxy-client.rst

@@ -8,10 +8,11 @@ the usual entry point for application interaction with the caching proxy.
 You need to configure a client or define your own service for the cache manager
 to work.
 
-The proxy client is also directly available as a service
-(``fos_http_cache.proxy_client.default`` and ``fos_http_cache.proxy_client.varnish``
-, ``fos_http_cache.proxy_client.nginx`` or ``fos_http_cache.proxy_client.symfony``)
-that you can use directly.
+The proxy client is also directly available as a service. The default client
+can be autowired with the ``FOS\HttpCache\ProxyClient\ProxyClient`` type
+declaration or the service ``fos_http_cache.default_proxy_client``. Specific
+clients, if configured, are available as ``fos_http_cache.proxy_client.varnish``
+, ``fos_http_cache.proxy_client.nginx`` or ``fos_http_cache.proxy_client.symfony``).
 
 If you need to adjust the proxy client, you can also configure the ``CacheManager``
 with a :ref:`custom proxy client <custom_proxy_client>` that you defined as a

composer.json

@@ -68,7 +68,7 @@
  },
  "extra": {
  "branch-alias": {
- "dev-master": "2.3.x-dev"
+ "dev-master": "2.4.x-dev"
  }
  }
 }