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 example/symfony54/.envexample/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": "git@github.com: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.*"
         }
     }
 }