tests/PHPUnit/Framework/MockObject/Matcher/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 require_once 'PHPUnit/Framework/MockObject/Invocation.php';
  51 require_once 'PHPUnit/Framework/MockObject/Verifiable.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * Interface for classes which matches an invocation based on its
  57  * method name, argument, order or call count.
  58  *
  59  * @category   Testing
  60  * @package    PHPUnit
  61  * @author     Jan Borsodi <jb@ez.no>
  62  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  63  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  64  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  65  * @version    Release: 3.3.17
  66  * @link       http://www.phpunit.de/
  67  * @since      Interface available since Release 3.0.0
  68  */
  69 interface PHPUnit_Framework_MockObject_Matcher_Invocation extends PHPUnit_Framework_SelfDescribing, PHPUnit_Framework_MockObject_Verifiable
  70 {
  71     /**
  72      * Registers the invocation $invocation in the object as being invoked.
  73      * This will only occur after matches() returns true which means the
  74      * current invocation is the correct one.
  75      *
  76      * The matcher can store information from the invocation which can later
  77      * be checked in verify(), or it can check the values directly and throw
  78      * and exception if an expectation is not met.
  79      *
  80      * If the matcher is a stub it will also have a return value.
  81      *
  82      * @param PHPUnit_Framework_MockObject_Invocation Object containing information on a mocked or
  83      *                                                  stubbed method which was invoked.
  84      * @return mixed
  85      */
  86     public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation);
  87
  88     /**
  89      * Checks if the invocation $invocation matches the current rules. If it does
  90      * the matcher will get the invoked() method called which should check if an
  91      * expectation is met.
  92      *
  93      * @param PHPUnit_Framework_MockObject_Invocation Object containing information on a mocked or
  94      *                                                  stubbed method which was invoked.
  95      * @return bool
  96      */
  97     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation);
  98 }
  99 ?>