class EmailHeaderSame
Hierarchy
- class \PHPUnit\Framework\Constraint\Constraint implements \Countable, \PHPUnit\Framework\SelfDescribing
- class \Symfony\Component\Mime\Test\Constraint\EmailHeaderSame extends \PHPUnit\Framework\Constraint\Constraint
Expanded class hierarchy of EmailHeaderSame
File
-
vendor/
symfony/ mime/ Test/ Constraint/ EmailHeaderSame.php, line 18
Namespace
Symfony\Component\Mime\Test\ConstraintView source
final class EmailHeaderSame extends Constraint {
public function __construct(string $headerName, string $expectedValue) {
}
public function toString() : string {
return \sprintf('has header "%s" with value "%s"', $this->headerName, $this->expectedValue);
}
/**
* @param RawMessage $message
*/
protected function matches($message) : bool {
if (RawMessage::class === $message::class) {
throw new \LogicException('Unable to test a message header on a RawMessage instance.');
}
return $this->expectedValue === $this->getHeaderValue($message);
}
/**
* @param RawMessage $message
*/
protected function failureDescription($message) : string {
return \sprintf('the Email %s (value is %s)', $this->toString(), $this->getHeaderValue($message) ?? 'null');
}
private function getHeaderValue($message) : ?string {
if (null === ($header = $message->getHeaders()
->get($this->headerName))) {
return null;
}
return $header instanceof UnstructuredHeader ? $header->getValue() : $header->getBodyAsString();
}
}
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::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 | ||
EmailHeaderSame::failureDescription | protected | function | Overrides Constraint::failureDescription | ||
EmailHeaderSame::getHeaderValue | private | function | |||
EmailHeaderSame::matches | protected | function | Overrides Constraint::matches | ||
EmailHeaderSame::toString | public | function | Returns a string representation of the object. | Overrides SelfDescribing::toString | |
EmailHeaderSame::__construct | public | function |