tests/PHPUnit/PHPUnit/Framework/MockObject/InvocationMocker.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2010-2011, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit_MockObject
  38  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  39  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  41  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  42  * @since      File available since Release 1.0.0
  43  */
  44
  45 /**
  46  * Mocker for invocations which are sent from
  47  * PHPUnit_Framework_MockObject_MockObject objects.
  48  *
  49  * Keeps track of all expectations and stubs as well as registering
  50  * identifications for builders.
  51  *
  52  * @package    PHPUnit_MockObject
  53  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  54  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  55  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  56  * @version    Release: 1.0.8
  57  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  58  * @since      Class available since Release 1.0.0
  59  */
  60 class PHPUnit_Framework_MockObject_InvocationMocker implements PHPUnit_Framework_MockObject_Stub_MatcherCollection, PHPUnit_Framework_MockObject_Invokable, PHPUnit_Framework_MockObject_Builder_Namespace
  61 {
  62     /**
  63      * @var PHPUnit_Framework_MockObject_Matcher_Invocation[]
  64      */
  65     protected $matchers = array();
  66
  67     /**
  68      * @var PHPUnit_Framework_MockObject_Builder_Match[]
  69      */
  70     protected $builderMap = array();
  71
  72     /**
  73      * @param PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
  74      */
  75     public function addMatcher(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher)
  76     {
  77         $this->matchers[] = $matcher;
  78     }
  79
  80     /**
  81      * @param  mixed $id
  82      * @return boolean|null
  83      */
  84     public function lookupId($id)
  85     {
  86         if (isset($this->builderMap[$id])) {
  87             return $this->builderMap[$id];
  88         }
  89
  90         return NULL;
  91     }
  92
  93     /**
  94      * @param  mixed                                      $id
  95      * @param  PHPUnit_Framework_MockObject_Builder_Match $builder
  96      * @throws PHPUnit_Framework_Exception
  97      */
  98     public function registerId($id, PHPUnit_Framework_MockObject_Builder_Match $builder)
  99     {
 100         if (isset($this->builderMap[$id])) {
 101             throw new PHPUnit_Framework_Exception(
 102               'Match builder with id <' . $id . '> is already registered.'
 103             );
 104         }
 105
 106         $this->builderMap[$id] = $builder;
 107     }
 108
 109     /**
 110      * @param  PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
 111      * @return PHPUnit_Framework_MockObject_Builder_InvocationMocker
 112      */
 113     public function expects(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher)
 114     {
 115         return new PHPUnit_Framework_MockObject_Builder_InvocationMocker(
 116           $this, $matcher
 117         );
 118     }
 119
 120     /**
 121      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
 122      * @return mixed
 123      */
 124     public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation)
 125     {
 126         $exception      = NULL;
 127         $hasReturnValue = FALSE;
 128
 129         if (strtolower($invocation->methodName) == '__tostring') {
 130             $returnValue = '';
 131         } else {
 132             $returnValue = NULL;
 133         }
 134
 135         foreach ($this->matchers as $match) {
 136             try {
 137                 if ($match->matches($invocation)) {
 138                     $value = $match->invoked($invocation);
 139
 140                     if (!$hasReturnValue) {
 141                         $returnValue    = $value;
 142                         $hasReturnValue = TRUE;
 143                     }
 144                 }
 145             }
 146
 147             catch (Exception $e) {
 148                 $exception = $e;
 149             }
 150         }
 151
 152         if ($exception !== NULL) {
 153             throw $exception;
 154         }
 155
 156         return $returnValue;
 157     }
 158
 159     /**
 160      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
 161      * @return boolean
 162      */
 163     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
 164     {
 165         foreach($this->matchers as $matcher) {
 166             if (!$matcher->matches($invocation)) {
 167                 return FALSE;
 168             }
 169         }
 170
 171         return TRUE;
 172     }
 173
 174     /**
 175      * @return boolean
 176      */
 177     public function verify()
 178     {
 179         foreach($this->matchers as $matcher) {
 180             $matcher->verify();
 181         }
 182     }
 183 }