Merge pull request #2059 from alcaeus/add-commandlogger-interface

Introduce interface for command loggers

lib/Doctrine/ODM/MongoDB/APM/CommandLogger.php

@@ -7,13 +7,12 @@
 use Countable;
 use MongoDB\Driver\Monitoring\CommandFailedEvent;
 use MongoDB\Driver\Monitoring\CommandStartedEvent;
-use MongoDB\Driver\Monitoring\CommandSubscriber;
 use MongoDB\Driver\Monitoring\CommandSucceededEvent;
 use function count;
 use function MongoDB\Driver\Monitoring\addSubscriber;
 use function MongoDB\Driver\Monitoring\removeSubscriber;
 
-final class CommandLogger implements Countable, CommandSubscriber
+final class CommandLogger implements Countable, CommandLoggerInterface
 {
     /** @var Command[] */
     private $commands = [];

lib/Doctrine/ODM/MongoDB/APM/CommandLoggerInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ODM\MongoDB\APM;
+
+use MongoDB\Driver\Monitoring\CommandSubscriber;
+
+interface CommandLoggerInterface extends CommandSubscriber
+{
+    /**
+     * Registers this command logger instance with the MongoDB library so it can receive command events
+     */
+    public function register() : void;
+
+    /**
+     * Unregisters this command logger instance with the MongoDB library so it no longer receives command events
+     */
+    public function unregister() : void;
+}