Test: document getClassMethodsHydratorClassName() with explanation of…

… why its there Signed-off-by: Alex Denvir <coldfff@gmail.com>
laminas-api-tools · Apr 9, 2020 · 3ae87a8 · 3ae87a8
1 parent c7099f8
commit 3ae87a8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/test/TableGatewayAbstractFactoryTest.php b/test/TableGatewayAbstractFactoryTest.php
@@ -243,6 +243,12 @@ public function testFactoryReturnsTableGatewayInstanceBasedOnConfigurationWithou
         $this->assertAttributeInstanceOf(TestAsset\Bar::class, 'objectPrototype', $resultSet);
     }
 
+    /**
+     * Simple check whether we should use ClassMethodsHydrator from laminas-hydrator 3
+     * as ClassMethods from < 3.0.0 is deprecated and triggers an E_USER_DEPRECATED error
+     *
+     * @return string
+     */
     private function getClassMethodsHydratorClassName()
     {
         if (class_exists(ClassMethodsHydrator::class)) {