Constraint that asserts that the array it is evaluated for has a given key.

Uses array_key_exists() to check if the key is found in the input array, if
not found the evaluation fails.

The array key is passed in the constructor.

CloneableFinalInstantiable
ExtendsPHPUnit\Framework\Constraint\Constraint
ImplementsCountable
PHPUnit\Framework\SelfDescribing
Methods
public __construct( $key)
 


    public PHPUnit\Framework\Constraint\Constraint::count() : int
     
    Counts the number of constraint elements.

    public PHPUnit\Framework\Constraint\Constraint::evaluate( $other, string $description = '', bool $returnResult = false)
     
    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 ExpectationFailedException
    • throws SebastianBergmann\RecursionContext\InvalidArgumentException
    public toString() : string
     
    Returns a string representation of the constraint.

    • throws SebastianBergmann\RecursionContext\InvalidArgumentException
    Methods
    protected PHPUnit\Framework\Constraint\Constraint::additionalFailureDescription( $other) : string
     
    Return additional failure description where needed

    The function can be overridden to provide additional failure
    information like a diff

      protected PHPUnit\Framework\Constraint\Constraint::exporter() : SebastianBergmann\Exporter\Exporter
      protected PHPUnit\Framework\Constraint\Constraint::fail( $other, $description, ?SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure = NULL) : void
       
      Throws an exception for the given compared value and test description

      • throws ExpectationFailedException
      • throws SebastianBergmann\RecursionContext\InvalidArgumentException
      protected failureDescription( $other) : string
       
      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.

      • throws SebastianBergmann\RecursionContext\InvalidArgumentException
      protected matches( $other) : bool
       
      Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.

        Properties
        private $key
         


        • var int|string
        © 2020 Bruce Wells
        Search Namespaces \ Classes
        ConfigurationNumbers (0-9.) only