class StringStartsWith

@no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit

Hierarchy

class \PHPUnit\Framework\Constraint\Constraint implements \Countable, \PHPUnit\Framework\SelfDescribing
- class \PHPUnit\Framework\Constraint\StringStartsWith extends \PHPUnit\Framework\Constraint\Constraint

Expanded class hierarchy of StringStartsWith

2 files declare their use of StringStartsWith

Assert.php in vendor/phpunit/phpunit/src/Framework/Assert.php
Functions.php in vendor/phpunit/phpunit/src/Framework/Assert/Functions.php

File

vendor/phpunit/phpunit/src/Framework/Constraint/String/StringStartsWith.php, line 18

Namespace

PHPUnit\Framework\Constraint

View source

final class StringStartsWith extends Constraint {
    private readonly string $prefix;
    
    /**
     * @throws EmptyStringException
     */
    public function __construct(string $prefix) {
        if ($prefix === '') {
            throw new EmptyStringException();
        }
        $this->prefix = $prefix;
    }
    
    /**
     * Returns a string representation of the constraint.
     */
    public function toString() : string {
        return 'starts with "' . $this->prefix . '"';
    }
    
    /**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     */
    protected function matches(mixed $other) : bool {
        return str_starts_with((string) $other, $this->prefix);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Constraint::additionalFailureDescription	protected	function	Return additional failure description where needed.		7
Constraint::count	public	function	Counts the number of constraint elements.		3
Constraint::evaluate	public	function	Evaluates the constraint for parameter $other.		7
Constraint::exporter	protected	function
Constraint::fail	protected	function	Throws an exception for the given compared value and test description.		1
Constraint::failureDescription	protected	function	Returns the description of the failure.		51
Constraint::failureDescriptionInContext	protected	function	Returns the description of the failure when this constraint appears in context of an $operator expression.
Constraint::reduce	protected	function	Reduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.		2
Constraint::toStringInContext	protected	function	Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
Constraint::valueToTypeStringFragment	protected	function	@psalm-return non-empty-string
StringStartsWith::$prefix	private	property
StringStartsWith::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.	Overrides Constraint::matches
StringStartsWith::toString	public	function	Returns a string representation of the constraint.	Overrides SelfDescribing::toString
StringStartsWith::__construct	public	function