Interface MatcherInterface

MatcherInterface defines how an expected value is matched against certain criteria. A matcher is also responsible for returning the TemplateInterface used for formatting match results.

Direct known implementers

Peridot\Leo\Matcher\AbstractMatcher

Indirect known implementers

Namespace: Peridot\Leo\Matcher
Package: Peridot\Leo\Matcher
Located at Matcher/MatcherInterface.php

Methods summary
`public boolean`	# `isNegated( )` Returns whether or not the matcher is negated. A negated matcher negates the results of a match. Returns whether or not the matcher is negated. A negated matcher negates the results of a match. Returns `boolean`
`public mixed`	# `invert( )` Inverts a matcher. If a matcher is not negated, it will become negated. If a matcher is negated, it will no longer be negated. Inverts a matcher. If a matcher is not negated, it will become negated. If a matcher is negated, it will no longer be negated. Returns `mixed` $this
`public Peridot\Leo\Matcher\Match`	# `match( mixed $actual )` Perform a match against an actual value. Perform a match against an actual value. Parameters `$actual` Returns `Peridot\Leo\Matcher\Match`
`public Peridot\Leo\Matcher\Template\TemplateInterface`	# `getTemplate( )` Return the TemplateInterface being used by the matcher. Return the TemplateInterface being used by the matcher. Returns `Peridot\Leo\Matcher\Template\TemplateInterface`
`public mixed`	# `setAssertion( Peridot\Leo\Assertion $assertion )` Set the Assertion bound to the matcher. Useful for checking flags from within a matcher. Set the Assertion bound to the matcher. Useful for checking flags from within a matcher. Parameters `$assertion` Returns `mixed`
`public mixed`	# `setTemplate( Peridot\Leo\Matcher\Template\TemplateInterface $template )` Set the TemplateInterface to use for formatting match results. Set the TemplateInterface to use for formatting match results. Parameters `$template` Returns `mixed` $this
`public Peridot\Leo\Matcher\Template\TemplateInterface`	# `getDefaultTemplate( )` Return a default TemplateInterface if none was set. Return a default TemplateInterface if none was set. Returns `Peridot\Leo\Matcher\Template\TemplateInterface`

Namespaces

Classes

Interfaces

Interface MatcherInterface

Direct known implementers

Indirect known implementers

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns