tests/PHPUnit/Framework/MockObject/Invocation.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, 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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Jan Borsodi <jb@ez.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.0.0
  46  */
  47
  48 require_once 'PHPUnit/Framework.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * Encapsulates information on a method invocation which can be passed to matchers.
  55  *
  56  * The invocation consists of the object it occured from, the class name, the
  57  * method name and all the parameters. The mock object must instantiate this
  58  * class with the values from the mocked method and pass it to an object of
  59  * PHPUnit_Framework_MockObject_Invokable.
  60  *
  61  * @category   Testing
  62  * @package    PHPUnit
  63  * @author     Jan Borsodi <jb@ez.no>
  64  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  65  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  66  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  67  * @version    Release: 3.3.17
  68  * @link       http://www.phpunit.de/
  69  * @since      Class available since Release 3.0.0
  70  */
  71 class PHPUnit_Framework_MockObject_Invocation implements PHPUnit_Framework_SelfDescribing
  72 {
  73     public $object;
  74
  75     public $className;
  76
  77     public $methodName;
  78
  79     public $parameters;
  80
  81     public function __construct($object, $className, $methodName, $parameters)
  82     {
  83         $this->object     = $object;
  84         $this->className  = $className;
  85         $this->methodName = $methodName;
  86         $this->parameters = $parameters;
  87
  88         foreach ($this->parameters as $key => $value) {
  89             if (is_object($value)) {
  90                 $this->parameters[$key] = $this->cloneObject($value);
  91             }
  92         }
  93     }
  94
  95     public function toString()
  96     {
  97         return sprintf(
  98           "%s::%s(%s)",
  99
 100           $this->className,
 101           $this->methodName,
 102           join(
 103             ', ',
 104             array_map(
 105               create_function(
 106                 '$a',
 107                 'return PHPUnit_Util_Type::shortenedExport($a);'
 108               ),
 109               $this->parameters
 110             )
 111           )
 112         );
 113     }
 114
 115     protected function cloneObject($original)
 116     {
 117         $object = new ReflectionObject($original);
 118
 119         if ($object->hasMethod('__clone')) {
 120             $method = $object->getMethod('__clone');
 121
 122             if (!$method->isPublic()) {
 123                 return $original;
 124             }
 125
 126             try {
 127                 return clone $original;
 128             }
 129
 130             catch (Exception $e) {
 131                 return $original;
 132             }
 133         }
 134
 135         return clone $original;
 136     }
 137 }
 138 ?>