PHPLIB-141: Static method for immutable BadMethodCallException

Author: jmikola

src/Exception/BadMethodCallException.php

@@ -4,6 +4,17 @@
 
 class BadMethodCallException extends \BadMethodCallException implements Exception
 {
+    /**
+     * Thrown when a mutable method is invoked on an immutable object.
+     *
+     * @param string $class Class name
+     * @return self
+     */
+    public static function classIsImmutable($class)
+    {
+        return new static(sprintf('%s is immutable', $class));
+    }
+
     /**
      * Thrown when accessing a result field on an unacknowledged write result.
      *

src/Model/IndexInfo.php

@@ -151,21 +151,21 @@ public function offsetGet($key)
      * Not supported.
      *
      * @see http://php.net/arrayaccess.offsetset
-     * @throws BadMethodCallException IndexInfo is immutable
+     * @throws BadMethodCallException
      */
     public function offsetSet($key, $value)
     {
-        throw new BadMethodCallException('IndexInfo is immutable');
+        throw BadMethodCallException::classIsImmutable(__CLASS__);
     }
 
     /**
      * Not supported.
      *
      * @see http://php.net/arrayaccess.offsetunset
-     * @throws BadMethodCallException IndexInfo is immutable
+     * @throws BadMethodCallException
      */
     public function offsetUnset($key)
     {
-        throw new BadMethodCallException('IndexInfo is immutable');
+        throw BadMethodCallException::classIsImmutable(__CLASS__);
     }
 }

tests/Model/IndexInfoTest.php

@@ -96,4 +96,36 @@ public function testDebugInfo()
         $info = new IndexInfo($expectedInfo);
         $this->assertSame($expectedInfo, $info->__debugInfo());
     }
+
+    /**
+     * @expectedException MongoDB\Exception\BadMethodCallException
+     * @expectedExceptionMessage MongoDB\Model\IndexInfo is immutable
+     */
+    public function testOffsetSetCannotBeCalled()
+    {
+        $info = new IndexInfo([
+            'v' => 1,
+            'key' => ['x' => 1],
+            'name' => 'x_1',
+            'ns' => 'foo.bar',
+        ]);
+
+        $info['v'] = 2;
+    }
+
+    /**
+     * @expectedException MongoDB\Exception\BadMethodCallException
+     * @expectedExceptionMessage MongoDB\Model\IndexInfo is immutable
+     */
+    public function testOffsetUnsetCannotBeCalled()
+    {
+        $info = new IndexInfo([
+            'v' => 1,
+            'key' => ['x' => 1],
+            'name' => 'x_1',
+            'ns' => 'foo.bar',
+        ]);
+
+        unset($info['v']);
+    }
 }