tests/PHPUnit/PHPUnit/Framework/MockObject/Matcher/InvokedRecorder.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  * Records invocations and provides convenience methods for checking them later
  47  * on.
  48  * This abstract class can be implemented by matchers which needs to check the
  49  * number of times an invocation has occured.
  50  *
  51  * @package    PHPUnit_MockObject
  52  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  53  * @copyright  2010-2011 Sebastian Bergmann <sb@sebastian-bergmann.de>
  54  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  55  * @version    Release: 1.0.8
  56  * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
  57  * @since      Class available since Release 1.0.0
  58  * @abstract
  59  */
  60 abstract class PHPUnit_Framework_MockObject_Matcher_InvokedRecorder implements PHPUnit_Framework_MockObject_Matcher_Invocation
  61 {
  62     /**
  63      * @var PHPUnit_Framework_MockObject_Invocation[]
  64      */
  65     protected $invocations = array();
  66
  67     /**
  68      * @return integer
  69      */
  70     public function getInvocationCount()
  71     {
  72         return count($this->invocations);
  73     }
  74
  75     /**
  76      * @return PHPUnit_Framework_MockObject_Invocation[]
  77      */
  78     public function getInvocations()
  79     {
  80         return $this->invocations;
  81     }
  82
  83     /**
  84      * @return boolean
  85      */
  86     public function hasBeenInvoked()
  87     {
  88         return count($this->invocations) > 0;
  89     }
  90
  91     /**
  92      * @param PHPUnit_Framework_MockObject_Invocation $invocation
  93      */
  94     public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
  95     {
  96         $this->invocations[] = $invocation;
  97     }
  98
  99     /**
 100      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
 101      * @return boolean
 102      */
 103     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
 104     {
 105         return TRUE;
 106     }
 107 }