setup custom callbacks

Author: Sam Stevens

BugsnagBundle.php

@@ -2,6 +2,8 @@
 
 namespace Bugsnag\BugsnagBundle;
 
+use Bugsnag\BugsnagBundle\DependencyInjection\Compiler\CallbackRegisteringPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 class BugsnagBundle extends Bundle
@@ -12,4 +14,13 @@ class BugsnagBundle extends Bundle
      * @return string
      */
     const VERSION = '1.0.0';
+
+    /**
+     * @inheritdoc
+     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+     */
+    public function build(ContainerBuilder $container)
+    {
+        $container->addCompilerPass(new CallbackRegisteringPass());
+    }
 }

DependencyInjection/ClientFactory.php

@@ -139,6 +139,13 @@ class ClientFactory
      */
     protected $filters;
 
+    /**
+     * Custom callbacks to register on the client.
+     *
+     * @var callable[]
+     */
+    protected $customCallbacks = [];
+
     /**
      * Create a new client factory instance.
      *
@@ -203,6 +210,26 @@ public function __construct(
         $this->filters = $filters;
     }
 
+    /**
+     * Add a custom callback to be registered on the client.
+     *
+     * @param callable|array $callable
+     */
+    public function addCallback($callable)
+    {
+        // If the parameter is not a callable (if the method name does not exist on the class for example),
+        // then throw an exception informing the user
+        if (! is_callable($callable)) {
+            throw new \RuntimeException(sprintf(
+                "Could not add Bugsnag callback. Class %s does not contain the \"%s\" method.",
+                get_class($callable[0]),
+                $callable[1]
+            ));
+        }
+
+        $this->customCallbacks[] = $callable;
+    }
+
     /**
      * Make a new client instance.
      *
@@ -248,6 +275,10 @@ public function make()
             $client->setFilters($this->filters);
         }
 
+        foreach ($this->customCallbacks as $callable) {
+            $client->registerCallback($callable);
+        }
+
         return $client;
     }
 

DependencyInjection/Compiler/CallbackRegisteringPass.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Bugsnag\BugsnagBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+class CallbackRegisteringPass implements CompilerPassInterface
+{
+    const FACTORY_SERVICE_NAME = 'bugsnag.factory';
+    const TAG_NAME = 'bugsnag.callback';
+
+    /**
+     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (! $container->has(self::FACTORY_SERVICE_NAME)) {
+            return;
+        }
+
+        // Get the Bugsnag factory service
+        $bugsnagFactory = $container->findDefinition(self::FACTORY_SERVICE_NAME);
+
+        // Get all services tagged as a callback
+        $callbackServices = $container->findTaggedServiceIds(self::TAG_NAME);
+
+        // Add each callback to the factory service via an addCallback call
+        foreach ($callbackServices as $id => $tags) {
+            foreach ($tags as $attributes) {
+                // Get the method name to call on the service from the tag definition,
+                // defaulting to registerCallback
+                $method = isset($attributes['method']) ? $attributes['method'] : 'registerCallback';
+                $bugsnagFactory->addMethodCall('addCallback', [[new Reference($id), $method]]);
+            }
+        }
+    }
+}