tests/PHPUnit/PHPUnit/Framework/MockObject/Matcher/MethodName.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  * Invocation matcher which looks for a specific method name in the invocations.
  47  *
  48  * Checks the method name all incoming invocations, the name is checked against
  49  * the defined constraint $constraint. If the constraint is met it will return
  50  * true in matches().
  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_Matcher_MethodName extends PHPUnit_Framework_MockObject_Matcher_StatelessInvocation
  61 {
  62     /**
  63      * @var PHPUnit_Framework_Constraint
  64      */
  65     protected $constraint;
  66
  67     /**
  68      * @param  PHPUnit_Framework_Constraint|string
  69      * @throws PHPUnit_Framework_Constraint
  70      */
  71     public function __construct($constraint)
  72     {
  73         if (!$constraint instanceof PHPUnit_Framework_Constraint) {
  74             if (!is_string($constraint)) {
  75                 throw PHPUnit_Util_InvalidArgumentHelper::factory(1, 'string');
  76             }
  77
  78             $constraint = new PHPUnit_Framework_Constraint_IsEqual(
  79               $constraint, 0, 10, FALSE, TRUE
  80             );
  81         }
  82
  83         $this->constraint = $constraint;
  84     }
  85
  86     /**
  87      * @return string
  88      */
  89     public function toString()
  90     {
  91         return 'method name ' . $this->constraint->toString();
  92     }
  93
  94     /**
  95      * @param  PHPUnit_Framework_MockObject_Invocation $invocation
  96      * @return boolean
  97      */
  98     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
  99     {
 100         return $this->constraint->evaluate($invocation->methodName);
 101     }
 102 }