tests/PHPUnit/Framework/MockObject/Invokable.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/Util/Filter.php';
  49 require_once 'PHPUnit/Framework/MockObject/Invocation.php';
  50 require_once 'PHPUnit/Framework/MockObject/Verifiable.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Interface for classes which can be invoked.
  56  *
  57  * The invocation will be taken from a mock object and passed to an object
  58  * of this class.
  59  *
  60  * @category   Testing
  61  * @package    PHPUnit
  62  * @author     Jan Borsodi <jb@ez.no>
  63  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  64  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  65  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  66  * @version    Release: 3.3.17
  67  * @link       http://www.phpunit.de/
  68  * @since      Interface available since Release 3.0.0
  69  */
  70 interface PHPUnit_Framework_MockObject_Invokable extends PHPUnit_Framework_MockObject_Verifiable
  71 {
  72     /**
  73      * Invokes the invocation object $invocation so that it can be checked for
  74      * expectations or matched against stubs.
  75      *
  76      * @return Object
  77      * @param PHPUnit_Framework_MockObject_Invocation $invocation The invocation object passed from
  78      *                                                              mock object.
  79      */
  80     public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation);
  81
  82     /**
  83      * Checks if the invocation matches.
  84      *
  85      * @return bool
  86      * @param PHPUnit_Framework_MockObject_Invocation $invocation The invocation object passed from
  87      *                                                              mock object.
  88      */
  89     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation);
  90 }
  91 ?>