Updated docs & samples

Author: Geolim4

README.md

@@ -1,25 +1,21 @@
 [![Code Climate](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache-bundle/badges/gpa.svg)](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache-bundle) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache-bundle/?branch=master) [![Build Status](https://travis-ci.org/PHPSocialNetwork/phpfastcache-bundle.svg?branch=master)](https://travis-ci.org/PHPSocialNetwork/phpfastcache-bundle) [![Latest Stable Version](http://img.shields.io/packagist/v/phpfastcache/phpfastcache-bundle.svg)](https://packagist.org/packages/phpfastcache/phpfastcache-bundle) [![Total Downloads](http://img.shields.io/packagist/dt/phpfastcache/phpfastcache-bundle.svg)](https://packagist.org/packages/phpfastcache/phpfastcache-bundle) [![Dependency Status](https://www.versioneye.com/php/phpfastcache:phpfastcache-bundle/badge.svg)](https://www.versioneye.com/php/phpfastcache:phpfastcache-bundle) [![License](https://img.shields.io/packagist/l/phpfastcache/phpfastcache-bundle.svg)](https://packagist.org/packages/phpfastcache/phpfastcache-bundle)
-# Symfony 3 PhpFastCache Bundle
+# Symfony 4 PhpFastCache Bundle
 
 #### :warning: Please note that the V3 is a major (BC breaking) update of the PhpFastCache Bundle !
 > As of the V3 the bundle is **absolutely** not compatible with previous versions.u the smoothest migration possible.
-One of the biggest change is the Phpfastcache's dependency which is not set to the v7 which it not backward compatible at all.
-Also please note that the bundle is currently in development and under a massive code rewrite.
-:warning: The code of the v3 is NOT production or development ready ATM.
-
+> One of the biggest change is the Phpfastcache's dependency which is not set to the v7 which it not backward compatible at all.
 
 #### :thumbsup: Step 1: Include phpFastCache Bundle in your project with composer:
 
 ```bash
 composer require phpfastcache/phpfastcache-bundle
 ```
 
-#### :construction: Step 2: Setup your config.yml to configure your cache(s) instance(s)
-
+#### :construction: Step 2: Setup your `config/packages/phpfastcache.yaml` to configure your cache(s) instance(s)
 
 ```yml
 # PhpFastCache configuration
-php_fast_cache:
+phpfastcache:
     twig_driver: "filecache" # This option must be a valid declared driver, in our example: "filecache"
     twig_block_debug: false # This option will wrap CACHE/ENDCACHE blocks with block debug as HTML comment
     drivers:
@@ -28,23 +24,15 @@ php_fast_cache:
             parameters:
                 path: "%kernel.cache_dir%/phpfastcache/"
 ```
-* More examples in Docs/Example/app/config
-
-#### :wrench: Step 3: Setup your AppKernel.php by adding the phpFastCache Bundle
-
-```php
-$bundles[] = new Phpfastcache\Bundle\phpFastCacheBundle();
-```
-
-* See the file Docs/Example/app/AppKernel.php for more information.
+* This step can be skipped using [Symfony recipes](https://symfony.com/doc/current/setup/flex.html).
 
-#### :rocket: Step 4: Accelerate your app by making use of PhpFastCache service
+#### :rocket: Step 3: Accelerate your app by making use of PhpFastCache service
 
 Caching data in your controller:
 ```php
-public function indexAction(Request $request)
+public function indexAction(Request $request, Phpfastcache $phpfastcache)
 {
-    $cache = $this->get('phpfastcache')->get('filecache');
+    $cache = $phpfastcache->get('filecache');
     $item = $cache->getItem('myAppData');
 
     if (!$item->isHit() || $item->get() === null) {

src/Resources/Docs/CREDITS.txt

@@ -20,16 +20,15 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-phpFastCache Bundle  Bundle Project Manager:   Georges.L (Geolim4)
+phpFastCache Bundle Project Manager:   Georges.L (Geolim4)
 
 phpFastCache Bundle Contributors:      https://github.com/PHPSocialNetwork/phpfastcache-bundle/graphs/contributors
 
 Specials thanks:
 
-- PastisD for helping us at the beginning of the project
+- PastisD for its momentous contributions
 - Alexander (asm89) for providing the great Twig Extension slightly modified and integrated to the PhpFastCache bundle
 
-
 Software licenses:
 
 PHP License, version 3.0:

src/Resources/Docs/example/Controller/DefaultController.php

@@ -2,6 +2,7 @@
 
 namespace AppBundle\Controller;
 
+use Phpfastcache\Bundle\Service\Phpfastcache;
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\Request;
@@ -12,30 +13,30 @@ class DefaultController extends Controller
     /**
      * @Route("/", name="homepage")
      */
-    public function indexAction(Request $request)
+    public function indexAction(Request $request, Phpfastcache $phpfastcache)
     {
         $pfc_test = null;
 
-        $cache = $this->get('phpfastcache')->get('filecache');
-        $cache2 = $this->get('phpfastcache')->get('memcachecache');
-        $cache3 = $this->get('phpfastcache')->get('ssdbcache');
-        $cache4 = $this->get('phpfastcache')->get('sqlitecache');
-        $cache5 = $this->get('phpfastcache')->get('rediscache');
-        $cache6 = $this->get('phpfastcache')->get('mongodbcache');
-        $cache7 = $this->get('phpfastcache')->get('couchbasecache');
-        $cache8 = $this->get('phpfastcache')->get('leveldbcache');
+        $cache = $phpfastcache->get('filecache');
+        $cache2 = $phpfastcache->get('memcachecache');
+        $cache3 = $phpfastcache->get('ssdbcache');
+        $cache4 = $phpfastcache->get('sqlitecache');
+        $cache5 = $phpfastcache->get('rediscache');
+        $cache6 = $phpfastcache->get('mongodbcache');
+        $cache7 = $phpfastcache->get('couchbasecache');
+        $cache8 = $phpfastcache->get('leveldbcache');
 
         /**
          * Xcache and APC cannot coexists
          */
         try{
-            $cache9 = $this->get('phpfastcache')->get('apccache');
-            $cache10 = $this->get('phpfastcache')->get('apcucache');
+            $cache9 = $phpfastcache->get('apccache');
+            $cache10 = $phpfastcache->get('apcucache');
         }catch(PhpfastcacheDriverCheckException $e){
-            $cache11 = $this->get('phpfastcache')->get('xcachecache');
+            $cache11 = $phpfastcache->get('xcachecache');
         }
 
-        $cache12 = $this->get('phpfastcache')->get('devnullcache');
+        $cache12 = $phpfastcache->get('devnullcache');
 
 
         $item = $cache->getItem('test');

src/Resources/Docs/example/Screenshoots/debugPanel.md

@@ -29,4 +29,57 @@ phpfastcache:
             parameters:
                 path: "%kernel.cache_dir%/phpfastcache/"
 ```
-Notice the change from "php_fast_cache" to "phpfastcache".
+Notice the change from "php_fast_cache" to "phpfastcache".
+
+### Service container
+
+We used to call the container getter to retrieve the "phpfastcache" service.
+#### :clock1: Then:
+```php
+<?php
+
+namespace AppBundle\Controller;
+
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Request;
+
+class DefaultController extends Controller
+{
+    /**
+     * @Route("/", name="homepage")
+     */
+    public function indexAction(Request $request)
+    {
+        $cache = $this->get('phpfastcache')->get('filecache');
+        // ...
+    }
+}
+```
+
+#### :alarm_clock: Now:
+This is no longer possible since the service is now private and can be retrieved via the dependency injection 
+using the Symfony [autowire](https://symfony.com/doc/current/service_container/autowiring.html) feature.
+```php
+<?php
+
+namespace AppBundle\Controller;
+
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Request;
+use Phpfastcache\Bundle\Service\Phpfastcache;
+
+class DefaultController extends Controller
+{
+    /**
+     * @Route("/", name="homepage")
+     */
+    public function indexAction(Request $request, Phpfastcache $phpfastcache)
+    {
+        $cache = $phpfastcache->get('filecache');
+        // ...
+    }
+}
+```
+