text: <?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
   */
  
  /**
   * Main matcher which defines a full expectation using method, parameter and
   * invocation matchers.
   * This matcher encapsulates all the other matchers and allows the builder to
   * set the specific matchers when the appropriate methods are called (once(),
   * where() etc.).
   *
   * All properties are public so that they can easily be accessed by the builder.
   *
   * @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_Matcher implements PHPUnit_Framework_MockObject_Matcher_Invocation
  {
      /**
       * @var PHPUnit_Framework_MockObject_Matcher_Invocation
       */
      public $invocationMatcher;
  
      /**
       * @var mixed
       */
      public $afterMatchBuilderId = NULL;
  
      /**
       * @var boolean
       */
      public $afterMatchBuilderIsInvoked = FALSE;
  
      /**
       * @var PHPUnit_Framework_MockObject_Matcher_MethodName
       */
      public $methodNameMatcher = NULL;
  
      /**
       * @var PHPUnit_Framework_MockObject_Matcher_Parameters
       */
      public $parametersMatcher = NULL;
  
      /**
       * @var PHPUnit_Framework_MockObject_Stub
       */
      public $stub = NULL;
  
      /**
       * @param PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher
       */
      public function __construct(PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher)
      {
          $this->invocationMatcher = $invocationMatcher;
      }
  
      /**
       * @return string
       */
      public function toString()
      {
          $list = array();
  
          if ($this->invocationMatcher !== NULL) {
              $list[] = $this->invocationMatcher->toString();
          }
  
          if ($this->methodNameMatcher !== NULL) {
              $list[] = 'where ' . $this->methodNameMatcher->toString();
          }
  
          if ($this->parametersMatcher !== NULL) {
              $list[] = 'and ' . $this->parametersMatcher->toString();
          }
  
          if ($this->afterMatchBuilderId !== NULL) {
              $list[] = 'after ' . $this->afterMatchBuilderId;
          }
  
          if ($this->stub !== NULL) {
              $list[] = 'will ' . $this->stub->toString();
          }
  
          return join(' ', $list);
      }
  
      /**
       * @param  PHPUnit_Framework_MockObject_Invocation $invocation
       * @return mixed
       */
      public function invoked(PHPUnit_Framework_MockObject_Invocation $invocation)
      {
          if ($this->invocationMatcher === NULL) {
              throw new PHPUnit_Framework_Exception(
                'No invocation matcher is set'
              );
          }
  
          if ($this->methodNameMatcher === NULL) {
              throw new PHPUnit_Framework_Exception('No method matcher is set');
          }
  
          if ($this->afterMatchBuilderId !== NULL) {
              $builder = $invocation->object
                                    ->__phpunit_getInvocationMocker()
                                    ->lookupId($this->afterMatchBuilderId);
  
              if (!$builder) {
                  throw new PHPUnit_Framework_Exception(
                    sprintf(
                      'No builder found for match builder identification <%s>',
  
                      $this->afterMatchBuilderId
                    )
                  );
              }
  
              $matcher = $builder->getMatcher();
  
              if ($matcher && $matcher->invocationMatcher->hasBeenInvoked()) {
                  $this->afterMatchBuilderIsInvoked = TRUE;
              }
          }
  
          $this->invocationMatcher->invoked($invocation);
  
          try {
              if ( $this->parametersMatcher !== NULL &&
                  !$this->parametersMatcher->matches($invocation)) {
                  $this->parametersMatcher->verify();
              }
          }
  
          catch (PHPUnit_Framework_ExpectationFailedException $e) {
              throw new PHPUnit_Framework_ExpectationFailedException(
                sprintf(
                  "Expectation failed for %s when %s\n%s",
  
                  $this->methodNameMatcher->toString(),
                  $this->invocationMatcher->toString(),
                  $e->getMessage()
                ),
                $e->getComparisonFailure()
              );
          }
  
          if ($this->stub) {
              return $this->stub->invoke($invocation);
          }
  
          return NULL;
      }
  
      /**
       * @param  PHPUnit_Framework_MockObject_Invocation $invocation
       * @return boolean
       */
      public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
      {
          if ($this->afterMatchBuilderId !== NULL) {
              $builder = $invocation->object
                                    ->__phpunit_getInvocationMocker()
                                    ->lookupId($this->afterMatchBuilderId);
  
              if (!$builder) {
                  throw new PHPUnit_Framework_Exception(
                    sprintf(
                      'No builder found for match builder identification <%s>',
  
                      $this->afterMatchBuilderId
                    )
                  );
              }
  
              $matcher = $builder->getMatcher();
  
              if (!$matcher) {
                  return FALSE;
              }
  
              if (!$matcher->invocationMatcher->hasBeenInvoked()) {
                  return FALSE;
              }
          }
  
          if ($this->invocationMatcher === NULL) {
              throw new PHPUnit_Framework_Exception(
                'No invocation matcher is set'
              );
          }
  
          if ($this->methodNameMatcher === NULL) {
              throw new PHPUnit_Framework_Exception('No method matcher is set');
          }
  
          if (!$this->invocationMatcher->matches($invocation)) {
              return FALSE;
          }
  
          try {
              if (!$this->methodNameMatcher->matches($invocation)) {
                  return FALSE;
              }
          }
  
          catch (PHPUnit_Framework_ExpectationFailedException $e) {
              throw new PHPUnit_Framework_ExpectationFailedException(
                sprintf(
                  "Expectation failed for %s when %s\n%s",
  
                  $this->methodNameMatcher->toString(),
                  $this->invocationMatcher->toString(),
                  $e->getMessage()
                ),
                $e->getComparisonFailure()
              );
          }
  
          return TRUE;
      }
  
      /**
       * @throws PHPUnit_Framework_Exception
       * @throws PHPUnit_Framework_ExpectationFailedException
       */
      public function verify()
      {
          if ($this->invocationMatcher === NULL) {
              throw new PHPUnit_Framework_Exception(
                'No invocation matcher is set'
              );
          }
  
          if ($this->methodNameMatcher === NULL) {
              throw new PHPUnit_Framework_Exception('No method matcher is set');
          }
  
          try {
              $this->invocationMatcher->verify();
  
              if ($this->parametersMatcher === NULL) {
                  $this->parametersMatcher = new PHPUnit_Framework_MockObject_Matcher_AnyParameters;
              }
  
              $invocationIsAny = get_class($this->invocationMatcher) === 'PHPUnit_Framework_MockObject_Matcher_AnyInvokedCount';
              if (!$invocationIsAny) {
                  $this->parametersMatcher->verify();
              }
          }
  
          catch (PHPUnit_Framework_ExpectationFailedException $e) {
              throw new PHPUnit_Framework_ExpectationFailedException(
                sprintf(
                  "Expectation failed for %s when %s.\n%s",
  
                  $this->methodNameMatcher->toString(),
                  $this->invocationMatcher->toString(),
                  $e->getMessage()
                )
              );
          }
      }
  }
  