Merge pull request #279 from KnpLabs/remove-non-lts-symfony-versions

Update dependencies and improve tests and documentation

Author: lcouellan

.travis.yml

@@ -9,24 +9,23 @@ env:
     global:
         - PHPUNIT_FLAGS="-v"
         - SYMFONY_PHPUNIT_DIR="$HOME/symfony-bridge/.phpunit"
-        - SYMFONY_REQUIRE='>=2.8'
-        - SYMFONY_DEPRECATIONS_HELPER="weak"
 
 matrix:
     fast_finish: true
     include:
-        - php: 7.1
         - php: 7.2
         - php: 7.3
+        - php: 7.4
           env: deps=low
 
 before_install:
     - phpenv config-rm xdebug.ini || true
-    - composer global require --no-progress --no-scripts --no-plugins symfony/flex dev-master
+    - composer global require --no-progress --no-scripts --no-plugins symfony/flex dev-main
 
 install:
     - |
       if [[ $deps = low ]]; then
+          export SYMFONY_DEPRECATIONS_HELPER=weak
           composer update --prefer-dist --prefer-lowest --prefer-stable
       else
           composer update --prefer-dist

README.markdown

@@ -18,16 +18,17 @@ With [composer](https://getcomposer.org), require:
 
 `composer require knplabs/knp-snappy-bundle`
 
-Then enable it in your kernel (optional if you are using the Flex recipe with Symfony4) :
+Then enable it in your kernel (optional if you are using the Flex recipe with Symfony >= 4) :
 
 ```php
-// app/AppKernel.php
-public function registerBundles()
-{
-    $bundles = array(
-        //...
-        new Knp\Bundle\SnappyBundle\KnpSnappyBundle(),
-        //...
+// config/bundles.php
+<?php
+
+return [
+    //...
+    Knp\Bundle\SnappyBundle\KnpSnappyBundle::class => ['all' => true],
+    //...
+];
 ```
 Configuration
 -------------
@@ -74,25 +75,29 @@ The bundle registers two services:
 ### Generate an image from a URL
 
 ```php
-$container->get('knp_snappy.image')->generate('http://www.google.fr', '/path/to/the/image.jpg');
+// @var Knp\Snappy\Image
+$knpSnappyImage->generate('http://www.google.fr', '/path/to/the/image.jpg');
 ```
 
 ### Generate a pdf document from a URL
 
 ```php
-$container->get('knp_snappy.pdf')->generate('http://www.google.fr', '/path/to/the/file.pdf');
+// @var Knp\Snappy\Pdf
+$knpSnappyPdf->generate('http://www.google.fr', '/path/to/the/file.pdf');
 ```
 
 ### Generate a pdf document from multiple URLs
 
 ```php
-$container->get('knp_snappy.pdf')->generate(array('http://www.google.fr', 'http://www.knplabs.com', 'http://www.google.com'), '/path/to/the/file.pdf');
+// @var Knp\Snappy\Pdf
+$knpSnappyPdf->generate(array('http://www.google.fr', 'http://www.knplabs.com', 'http://www.google.com'), '/path/to/the/file.pdf');
 ```
 
 ### Generate a pdf document from a twig view
 
 ```php
-$this->get('knp_snappy.pdf')->generateFromHtml(
+// @var Knp\Snappy\Pdf
+$knpSnappyPdf->generateFromHtml(
     $this->renderView(
         'MyBundle:Foo:bar.html.twig',
         array(
@@ -107,17 +112,18 @@ $this->get('knp_snappy.pdf')->generateFromHtml(
 
 ```php
 use Knp\Bundle\SnappyBundle\Snappy\Response\JpegResponse;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 
-class SomeController
+class SomeController extends AbstractController
 {
-    public function imageAction()
+    public function imageAction(Knp\Snappy\Image $knpSnappyImage)
     {
         $html = $this->renderView('MyBundle:Foo:bar.html.twig', array(
             'some'  => $vars
         ));
 
         return new JpegResponse(
-            $this->get('knp_snappy.image')->getOutputFromHtml($html),
+            $knpSnappyImage->getOutputFromHtml($html),
             'image.jpg'
         );
     }
@@ -128,17 +134,18 @@ class SomeController
 
 ```php
 use Knp\Bundle\SnappyBundle\Snappy\Response\PdfResponse;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 
-class SomeController extends Controller
+class SomeController extends AbstractController
 {
-    public function pdfAction()
+    public function pdfAction(Knp\Snappy\Pdf $knpSnappyPdf)
     {
         $html = $this->renderView('MyBundle:Foo:bar.html.twig', array(
             'some'  => $vars
         ));
 
         return new PdfResponse(
-            $this->get('knp_snappy.pdf')->getOutputFromHtml($html),
+            $knpSnappyPdf->getOutputFromHtml($html),
             'file.pdf'
         );
     }
@@ -149,15 +156,16 @@ class SomeController extends Controller
 
 ```php
 use Knp\Bundle\SnappyBundle\Snappy\Response\PdfResponse;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 
-class SomeController extends Controller
+class SomeController extends AbstractController
 {
-    public function pdfAction()
+    public function pdfAction(Knp\Snappy\Pdf $knpSnappyPdf)
     {
         $pageUrl = $this->generateUrl('homepage', array(), true); // use absolute path!
 
         return new PdfResponse(
-            $this->get('knp_snappy.pdf')->getOutput($pageUrl),
+            $knpSnappyPdf->getOutput($pageUrl),
             'file.pdf'
         );
     }

composer.json

@@ -16,9 +16,9 @@
         }
     ],
     "require": {
-        "php":                      ">=7.1",
-        "symfony/framework-bundle": "^3.4|^4.3|^5.0",
-        "knplabs/knp-snappy":       "~1.0,>=1.0.1"
+        "php":                      ">=7.2.5",
+        "symfony/framework-bundle": "^4.4|^5.1",
+        "knplabs/knp-snappy":       "^1.2"
     },
     "autoload": {
         "psr-4": {
@@ -30,19 +30,14 @@
             "Knp\\Bundle\\SnappyBundle\\Tests\\": "tests/"
         }
     },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "1.x-dev"
-        }
-    },
     "require-dev": {
-        "doctrine/annotations": "~1.0",
-        "symfony/asset": "^3.4|^4.3|^5.0",
-        "symfony/finder": "^3.4|^4.3|^5.0",
-        "symfony/phpunit-bridge": "^4.3|^5.0",
-        "symfony/security-csrf": "^3.4|^4.3|^5.0",
-        "symfony/templating": "^3.4|^4.3|^5.0",
-        "symfony/validator": "^3.4|^4.3|^5.0",
-        "symfony/yaml": "^3.4|^4.3|^5.0"
+        "doctrine/annotations": "^1.11",
+        "symfony/asset": "^4.4|^5.1",
+        "symfony/finder": "^4.4|^5.1",
+        "symfony/phpunit-bridge": "^4.4|^5.1",
+        "symfony/security-csrf": "^4.4|^5.1",
+        "symfony/templating": "^4.4|^5.1",
+        "symfony/validator": "^4.4|^5.1",
+        "symfony/yaml": "^4.4|^5.1"
     }
 }

tests/fixtures/config/base.yml

@@ -1,6 +1,6 @@
 framework:
     secret:          ThisIsNotReallyASecretSoPleaseChangeIt
-    router:          { resource: "%kernel.project_dir%/config/routing.yml" }
+    router:          { resource: "%kernel.project_dir%/config/routing.yml", utf8: true }
     csrf_protection: true
     validation:      { enabled: true, enable_annotations: true }
     session:         ~