Merge pull request #167 from bugsnag/SUP-3042/upgrade-symfony50-example-to-54

Symfony dependencies in composer.json updated to 5.4

Author: mclack

example/symfony50/README.md

@@ -0,0 +1,81 @@
+# Running BugSnag with Symfony 5
+
+This example shows how to integrate BugSnag with Symfony 5.  Full instructions on how to set BugSnag up with Symfony can be found in [the official BugSnag documentation](https://docs.bugsnag.com/platforms/php/symfony/).
+
+
+## Installing dependencies
+
+1. Install composer, following the instructions provided in the [composer documentation](http://getcomposer.org/doc/01-basic-usage.md)
+
+2. Install BugSnag using composer
+
+    ```shell
+    composer install
+    ```
+
+## Configuring BugSnag
+
+There are two ways of configuring your BugSnag client.
+
+1. Set the configuration options in `config/packages/bugsnag.yaml`.  These values will automatically be loaded in when the application starts.
+
+```yaml
+bugsnag:
+    api_key: 'YOUR_API_KEY'
+    auto_notify: true
+```
+
+2. Use environment variables.  In this example you can set the `BUGSNAG_API_KEY` environment variable to your api key. This can also be set in the applications `.env` file:
+
+```
+BUGSNAG_API_KEY=YOUR_API_KEY_HERE
+```
+
+More information about configuring BugSnag can be found in [the configuration section of the BugSnag documentation](https://docs.bugsnag.com/platforms/php/symfony/configuration-options/).
+
+In Symfony 5 the BugSnag bundle should be automatically registered in the `config/bundles.php` file:
+```php
+return [
+    // ...
+    Bugsnag\BugsnagBundle\BugsnagBundle::class => ['all' => true],
+];
+```
+
+BugSnag will now be set up and ready to notify of any exceptions.
+
+## Manually Acquiring the BugSnag Bundle
+
+In order to use BugSnag in any of your classes you will need to require it via dependency injection.
+
+In your services.yaml file, bind the Bugsnag\Client class to the @bugsnag service:
+```yaml
+services:
+    # resolve "Bugsnag\Client" to the BugSnag service
+    Bugsnag\Client: '@bugsnag'
+```
+
+Any of your classes requiring BugSnag can use the type Bugsnag\Client to access it:
+```php
+private $bugsnag;
+
+public function __construct(\Bugsnag\Client $bugsnag)
+{
+    $this->bugsnag = $bugsnag;
+}
+```
+
+Which allows BugSnag to be used within the class as you would any other property.
+
+## Running the example
+
+To run the example:
+
+```shell
+symfony server:start
+```
+
+Or for the command example:
+
+```shell
+php bin/console app:crash
+```

example/symfony50/.env renamed to example/symfony54/.env

@@ -8,25 +8,27 @@
         "ext-iconv": "*",
         "bugsnag/bugsnag-symfony": "^1.5.0",
         "sensio/framework-extra-bundle": "^5.5@dev",
-        "symfony/console": "5.0.*",
-        "symfony/dotenv": "5.0.*",
+        "symfony/console": "5.4.*",
+        "symfony/dotenv": "5.4.*",
         "symfony/flex": "^1.3.1",
-        "symfony/framework-bundle": "5.0.*",
-        "symfony/yaml": "5.0.*"
+        "symfony/framework-bundle": "5.4.*",
+        "symfony/routing": "^5.4",
+        "symfony/yaml": "5.4.*"
     },
     "repositories": [
         {
             "type": "vcs",
             "url": "[email protected]:bugsnag/bugsnag-symfony.git"
         }
     ],
-    "require-dev": {
-    },
     "config": {
         "preferred-install": {
             "*": "dist"
         },
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "symfony/flex": false
+        }
     },
     "autoload": {
         "psr-4": {
@@ -65,7 +67,7 @@
     "extra": {
         "symfony": {
             "allow-contrib": false,
-            "require": "5.0.*"
+            "require": "5.4.*"
         }
     }
 }

example/symfony50/.gitignore renamed to example/symfony54/.gitignore

@@ -0,0 +1,9 @@
+<?php
+
+if (file_exists(dirname(__DIR__).'/var/cache/prod/srcApp_KernelProdContainer.preload.php')) {
+    require dirname(__DIR__).'/var/cache/prod/srcApp_KernelProdContainer.preload.php';
+}
+
+if (file_exists(dirname(__DIR__).'/var/cache/prod/App_KernelProdContainer.preload.php')) {
+    require dirname(__DIR__).'/var/cache/prod/App_KernelProdContainer.preload.php';
+}

example/symfony54/README.md

@@ -6,12 +6,12 @@
 parameters:
 
 services:
+    # resolve "Bugsnag\Client" to the BugSnag service
+    Bugsnag\Client: '@bugsnag'
     # default configuration for services in *this* file
     _defaults:
         autowire: true      # Automatically injects dependencies in your services.
         autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
-        bind:
-            $bugsnag: '@bugsnag'
 
     # makes classes in src/ available to be used as services
     # this creates a service per class whose id is the fully-qualified class name

example/symfony50/bin/console renamed to example/symfony54/bin/console

@@ -10,9 +10,9 @@
 
 class DefaultController extends AbstractController
 {
-    protected $bugsnag;
+    private $bugsnag;
 
-    public function __construct($bugsnag)
+    public function __construct(\Bugsnag\Client $bugsnag)
     {
         $this->bugsnag = $bugsnag;
     }
@@ -22,7 +22,7 @@ public function __construct($bugsnag)
      */
     public function index()
     {
-        return new Response('Welcome to the Bugsnag Symfony 5 example. Visit the
+        return new Response('Welcome to the BugSnag Symfony 5 example. Visit the
          file "src/Controller/DefaultController" to see how certain functions 
         are implemented, and routes they can be tested on.');
     }
@@ -32,7 +32,7 @@ public function index()
      */
     public function crash()
     {
-        throw new RuntimeException('It crashed!  Go to your Bugsnag dashboard to view the exception');
+        throw new RuntimeException('It crashed!  Go to your BugSnag dashboard to view the exception');
     }
 
     /**
@@ -49,7 +49,7 @@ public function callback()
             ]);
         });
 
-        throw new RuntimeException('It crashed!  Go to your Bugsnag dashboard to view the exception and metadata');
+        throw new RuntimeException('It crashed!  Go to your BugSnag dashboard to view the exception and metadata');
     }
 
     /**
@@ -59,7 +59,7 @@ public function notify()
     {
         $this->bugsnag->notifyException(new RuntimeException("It didn't crash!"));
 
-        return new Response("It didn't crash, but check your Bugsnag dashboard for the manual notification");
+        return new Response("It didn't crash, but check your BugSnag dashboard for the manual notification");
     }
 
     /**
@@ -76,7 +76,7 @@ public function metadata()
             ]);
         });
 
-        return new Response("It didn't crash, but check your Bugsnag dashboard for the manual notification with additional metadata");
+        return new Response("It didn't crash, but check your BugSnag dashboard for the manual notification with additional metadata");
     }
 
     /**
@@ -88,6 +88,6 @@ public function severity()
             $report->setSeverity('info');
         });
 
-        return new Response("It didn't crash, but check your Bugsnag dashboard for the manual notification, and check the severity of the report");
+        return new Response("It didn't crash, but check your BugSnag dashboard for the manual notification, and check the severity of the report");
     }
 }