annotate vendor/phpunit/phpunit-mock-objects/src/Builder/ParametersMatch.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@14 1 <?php
Chris@14 2 /*
Chris@14 3 * This file is part of the phpunit-mock-objects package.
Chris@14 4 *
Chris@14 5 * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@14 6 *
Chris@14 7 * For the full copyright and license information, please view the LICENSE
Chris@14 8 * file that was distributed with this source code.
Chris@14 9 */
Chris@14 10 namespace PHPUnit\Framework\MockObject\Builder;
Chris@14 11
Chris@14 12 use PHPUnit\Framework\MockObject\Matcher\AnyParameters;
Chris@14 13
Chris@14 14 /**
Chris@14 15 * Builder interface for parameter matchers.
Chris@14 16 */
Chris@14 17 interface ParametersMatch extends Match
Chris@14 18 {
Chris@14 19 /**
Chris@14 20 * Sets the parameters to match for, each parameter to this function will
Chris@14 21 * be part of match. To perform specific matches or constraints create a
Chris@14 22 * new PHPUnit\Framework\Constraint\Constraint and use it for the parameter.
Chris@14 23 * If the parameter value is not a constraint it will use the
Chris@14 24 * PHPUnit\Framework\Constraint\IsEqual for the value.
Chris@14 25 *
Chris@14 26 * Some examples:
Chris@14 27 * <code>
Chris@14 28 * // match first parameter with value 2
Chris@14 29 * $b->with(2);
Chris@14 30 * // match first parameter with value 'smock' and second identical to 42
Chris@14 31 * $b->with('smock', new PHPUnit\Framework\Constraint\IsEqual(42));
Chris@14 32 * </code>
Chris@14 33 *
Chris@14 34 * @return ParametersMatch
Chris@14 35 */
Chris@14 36 public function with(...$arguments);
Chris@14 37
Chris@14 38 /**
Chris@14 39 * Sets a matcher which allows any kind of parameters.
Chris@14 40 *
Chris@14 41 * Some examples:
Chris@14 42 * <code>
Chris@14 43 * // match any number of parameters
Chris@14 44 * $b->withAnyParameters();
Chris@14 45 * </code>
Chris@14 46 *
Chris@14 47 * @return AnyParameters
Chris@14 48 */
Chris@14 49 public function withAnyParameters();
Chris@14 50 }