ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: home / centosnipponia / public_html / apptt-oldgit / vendor / phpunit / phpunit / src / Framework / Constraint

<?php declare(strict_types=1);
/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\Framework\Constraint;

use function sprintf;
use Countable;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\SelfDescribing;
use SebastianBergmann\Comparator\ComparisonFailure;
use SebastianBergmann\Exporter\Exporter;

/**
 * Abstract base class for constraints which can be applied to any value.
 */
abstract class Constraint implements Countable, SelfDescribing
{
    /**
     * @var Exporter
     */
    private $exporter;

/**
     * Evaluates the constraint for parameter $other.
     *
     * If $returnResult is set to false (the default), an exception is thrown
     * in case of a failure. null is returned otherwise.
     *
     * If $returnResult is true, the result of the evaluation is returned as
     * a boolean value instead: true in case of success, false in case of a
     * failure.
     *
     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
     * @throws ExpectationFailedException
     */
    public function evaluate($other, string $description = '', bool $returnResult = false)
    {
        $success = false;

if ($this->matches($other)) {
            $success = true;
        }

if ($returnResult) {
            return $success;
        }

if (!$success) {
            $this->fail($other, $description);
        }
    }

/**
     * Counts the number of constraint elements.
     */
    public function count(): int
    {
        return 1;
    }

protected function exporter(): Exporter
    {
        if ($this->exporter === null) {
            $this->exporter = new Exporter;
        }

return $this->exporter;
    }

/**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     *
     * This method can be overridden to implement the evaluation algorithm.
     *
     * @param mixed $other value or object to evaluate
     *
     * @codeCoverageIgnore
     */
    protected function matches($other): bool
    {
        return false;
    }

/**
     * Throws an exception for the given compared value and test description.
     *
     * @param mixed             $other             evaluated value or object
     * @param string            $description       Additional information about the test
     * @param ComparisonFailure $comparisonFailure
     *
     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
     * @throws ExpectationFailedException
     *
     * @psalm-return never-return
     */
    protected function fail($other, $description, ComparisonFailure $comparisonFailure = null): void
    {
        $failureDescription = sprintf(
            'Failed asserting that %s.',
            $this->failureDescription($other)
        );

$additionalFailureDescription = $this->additionalFailureDescription($other);

if ($additionalFailureDescription) {
            $failureDescription .= "\n" . $additionalFailureDescription;
        }

if (!empty($description)) {
            $failureDescription = $description . "\n" . $failureDescription;
        }

throw new ExpectationFailedException(
            $failureDescription,
            $comparisonFailure
        );
    }

/**
     * Return additional failure description where needed.
     *
     * The function can be overridden to provide additional failure
     * information like a diff
     *
     * @param mixed $other evaluated value or object
     */
    protected function additionalFailureDescription($other): string
    {
        return '';
    }

/**
     * Returns the description of the failure.
     *
     * The beginning of failure messages is "Failed asserting that" in most
     * cases. This method should return the second part of that sentence.
     *
     * To provide additional failure information additionalFailureDescription
     * can be used.
     *
     * @param mixed $other evaluated value or object
     *
     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
     */
    protected function failureDescription($other): string
    {
        return $this->exporter()->export($other) . ' ' . $this->toString();
    }
}

[+] ..
[-] ArrayHasKey.php [edit]
[-] ArraySubset.php [edit]
[-] Attribute.php [edit]
[-] Callback.php [edit]
[-] ClassHasAttribute.php [edit]
[-] ClassHasStaticAttribute.php [edit]
[-] Composite.php [edit]
[-] Constraint.php [edit]
[-] Count.php [edit]
[-] DirectoryExists.php [edit]
[-] Exception.php [edit]
[-] ExceptionCode.php [edit]
[-] ExceptionMessage.php [edit]
[-] ExceptionMessageRegularExpression.php [edit]
[-] FileExists.php [edit]
[-] GreaterThan.php [edit]
[-] IsAnything.php [edit]
[-] IsEmpty.php [edit]
[-] IsEqual.php [edit]
[-] IsFalse.php [edit]
[-] IsFinite.php [edit]
[-] IsIdentical.php [edit]
[-] IsInfinite.php [edit]
[-] IsInstanceOf.php [edit]
[-] IsJson.php [edit]
[-] IsNan.php [edit]
[-] IsNull.php [edit]
[-] IsReadable.php [edit]
[-] IsTrue.php [edit]
[-] IsType.php [edit]
[-] IsWritable.php [edit]
[-] JsonMatches.php [edit]
[-] JsonMatchesErrorMessageProvider.php [edit]
[-] LessThan.php [edit]
[-] LogicalAnd.php [edit]
[-] LogicalNot.php [edit]
[-] LogicalOr.php [edit]
[-] LogicalXor.php [edit]
[-] ObjectHasAttribute.php [edit]
[-] RegularExpression.php [edit]
[-] SameSize.php [edit]
[-] StringContains.php [edit]
[-] StringEndsWith.php [edit]
[-] StringMatchesFormatDescription.php [edit]
[-] StringStartsWith.php [edit]
[-] TraversableContains.php [edit]
[-] TraversableContainsEqual.php [edit]
[-] TraversableContainsIdentical.php [edit]
[-] TraversableContainsOnly.php [edit]
[-] .htaccess.disabled [edit]