README, services.yaml and DefaultController updated to reflect current BugSnag Symfony integration docs. Routes tested and exceptions reported successfully.

Author: mclack

example/symfony54/README.md

@@ -1,27 +1,27 @@
-# Running Bugsnag with Symfony 5
+# Running BugSnag with Symfony 6
 
-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/).
+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
+2. Install BugSnag using composer
 
     ```shell
     composer install
     ```
 
-## Configuring Bugsnag
+## Configuring BugSnag
 
-There are two ways of configuring your Bugsnag client.
+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_HERE
+    api_key: 'YOUR_API_KEY'
     auto_notify: true
 ```
 
@@ -31,43 +31,40 @@ bugsnag:
 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/).
+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:
+In Symfony 6 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.
+BugSnag will now be set up and ready to notify of any exceptions.
 
-## Manually Acquiring the Bugsnag Bundle
+## Manually Acquiring the BugSnag Bundle
 
-In order to manually use Bugsnag in any of your controllers you will need to require it via dependency injection.
+In order to use BugSnag in any of your classes you will need to require it via dependency injection.
 
-In your `services.yml` file, you should bind the Bugsnag instance to your service parameters by:
+In your services.yaml file, bind the Bugsnag\Client class to the @bugsnag service:
 ```yaml
 services:
-    # default configuration for services in *this* file
-    _defaults:
-        # ...
-        bind:
-            $bugsnag: '@bugsnag'
+    # resolve "Bugsnag\Client" to the BugSnag service
+    Bugsnag\Client: '@bugsnag'
 ```
 
-This will make any methods with a `$bugsnag` argument be passed the Bugsnag bundle:
-
+Any of your classes requiring BugSnag can use the type Bugsnag\Client to access it:
 ```php
-protected $bugsnag;
+private $bugsnag;
 
-public function __construct($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.
+Which allows BugSnag to be used within the class as you would any other property.
 
 ## Running the example
 

example/symfony54/config/services.yaml

@@ -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/symfony54/src/Controller/DefaultController.php

@@ -10,19 +10,20 @@
 
 class DefaultController extends AbstractController
 {
-    protected $bugsnag;
+    private $bugsnag;
 
-    public function __construct($bugsnag)
+    public function __construct(\Bugsnag\Client $bugsnag)
     {
         $this->bugsnag = $bugsnag;
     }
+    
 
     /**
      * @Route("/", name="homepage")
      */
     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 +33,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 +50,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 +60,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 +77,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 +89,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");
     }
 }