PHPUnit's returnValueMap not yielding expected results

Question

I\'m trying to use PHPUnit\'s returnValueMap() to stub out the results of a read. It isn\'t yielding the expected results, but an equivalent returnCallback() does. I\'ve made

Answer 1

I've been hunting down this same problem and eventually out of desperation xdebug-stepped through Framework/MockObject/Stub/ReturnValueMap.php and Framework/MockObject/InvocationMocker.php [in method InvocationMocker::invoke(PHPUnit_Framework_MockObject_Invocation $invocation) ], and I've observed the following points:

1. Not only must the values in the map-array that you supply be the same as the expected parameters when the stubbed function is called, but they MUST BE OF THE SAME TYPE. This is because inside Framework/MockObject/Stub/ReturnValueMap.php in the ReturnValueMap::invoke() method, the comparison between the supplied parameters and the expected parameters is compared in line 75 as follows:

   if ($invocation->parameters === $map) {
   

   So, the anticipated result of

   $mock->myStubbedMethod( "1", "2" )
   

   using a map-array of

   array(
       array( 1, 1, 500 ),
       array( 1, 2, 700 )
   )
   

   will disappoint. Instead, the result will be a NULL.

2. On a much more subtle point, you may have stubbed the method using two different mock scenarios (as I did - yes, silly me!)

   So, to elucidate, the first mock-stub could contain

   $mock->expects( $this->any() )
          ->method('myStubbedMethod')
          ->will( $this->returnValue(750) );
   

   and then later, in the same unit-test method, it could contain

   $arrMap = array(
       array( 1, 1, 500 ),
       array( 1, 2, 700 ),
       array( 2, 3, 1500 ),
   );
   $mock->expects( $this->any() )
           ->method('myStubbedMethod')
           ->will( $this->returnValueMap($arrMap) );
   

   When the stubbed-method is invoked, the map-array version will be implemented. This is obvious and self-evident, however while coding in the heat of the moment, and while separating different code behaviour in your mind as you develop, it's easily overlooked.