InvocationMocker.php

1. 8.x drupal/core/vendor/phpunit/phpunit-mock-objects/PHPUnit/Framework/MockObject/InvocationMocker.php
2. 8.x drupal/core/vendor/phpunit/phpunit-mock-objects/PHPUnit/Framework/MockObject/Builder/InvocationMocker.php

<?php

/**
 * PHPUnit
 *
 * Copyright (c) 2010-2013, Sebastian Bergmann <sb@sebastian-bergmann.de>.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Sebastian Bergmann nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    PHPUnit_MockObject
 * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @copyright  2010-2013 Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
 * @since      File available since Release 1.0.0
 */

/**
 * Mocker for invocations which are sent from
 * PHPUnit_Framework_MockObject_MockObject objects.
 *
 * Keeps track of all expectations and stubs as well as registering
 * identifications for builders.
 *
 * @package    PHPUnit_MockObject
 * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @copyright  2010-2013 Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @version    Release: @package_version@
 * @link       http://github.com/sebastianbergmann/phpunit-mock-objects
 * @since      Class available since Release 1.0.0
 */
class PHPUnit_Framework_MockObject_InvocationMocker implements PHPUnit_Framework_MockObject_Stub_MatcherCollection, PHPUnit_Framework_MockObject_Invokable, PHPUnit_Framework_MockObject_Builder_Namespace {

  /**
   * @var PHPUnit_Framework_MockObject_Matcher_Invocation[]
   */
  protected $matchers = array();

  /**
   * @var PHPUnit_Framework_MockObject_Builder_Match[]
   */
  protected $builderMap = array();

  /**
   * @param PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
   */
  public function addMatcher(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher) {
    $this->matchers[] = $matcher;
  }

  /**
   * @since Method available since Release 1.1.0
   */
  public function hasMatchers() {
    if (empty($this->matchers)) {
      return FALSE;
    }
    foreach ($this->matchers as $matcher) {
      if (!$matcher instanceof PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * @param  mixed $id
   * @return boolean|null
   */
  public function lookupId($id) {
    if (isset($this->builderMap[$id])) {
      return $this->builderMap[$id];
    }
    return NULL;
  }

  /**
   * @param  mixed                                      $id
   * @param  PHPUnit_Framework_MockObject_Builder_Match $builder
   * @throws PHPUnit_Framework_Exception
   */
  public function registerId($id, PHPUnit_Framework_MockObject_Builder_Match $builder) {
    if (isset($this->builderMap[$id])) {
      throw new PHPUnit_Framework_Exception('Match builder with id <' . $id . '> is already registered.');
    }
    $this->builderMap[$id] = $builder;
  }

  /**
   * @param  PHPUnit_Framework_MockObject_Matcher_Invocation $matcher
   * @return PHPUnit_Framework_MockObject_Builder_InvocationMocker
   */
  public function expects(PHPUnit_Framework_MockObject_Matcher_Invocation $matcher) {
    return new PHPUnit_Framework_MockObject_Builder_InvocationMocker($this, $matcher);
  }

  /**
   * @param  PHPUnit_Framework_MockObject_Invocation $invocation
   * @return mixed
   */
  public function invoke(PHPUnit_Framework_MockObject_Invocation $invocation) {
    $exception = NULL;
    $hasReturnValue = FALSE;
    if (strtolower($invocation->methodName) == '__tostring') {
      $returnValue = '';
    }
    else {
      $returnValue = NULL;
    }
    foreach ($this->matchers as $match) {
      try {
        if ($match
          ->matches($invocation)) {
          $value = $match
            ->invoked($invocation);
          if (!$hasReturnValue) {
            $returnValue = $value;
            $hasReturnValue = TRUE;
          }
        }
      } catch (Exception $e) {
        $exception = $e;
      }
    }
    if ($exception !== NULL) {
      throw $exception;
    }
    return $returnValue;
  }

  /**
   * @param  PHPUnit_Framework_MockObject_Invocation $invocation
   * @return boolean
   */
  public function matches(PHPUnit_Framework_MockObject_Invocation $invocation) {
    foreach ($this->matchers as $matcher) {
      if (!$matcher
        ->matches($invocation)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * @return boolean
   */
  public function verify() {
    foreach ($this->matchers as $matcher) {
      $matcher
        ->verify();
    }
  }

}