66
77// This file is generated from the static method @factory doctags.
88
9- use Hamcrest \Matcher ;
10-
119if (!function_exists ('assertThat ' )) {
1210 /**
1311 * Make an assertion and throw {@link Hamcrest_AssertionError} if it fails.
@@ -146,6 +144,7 @@ function hasKey($key): \Hamcrest\Arrays\IsArrayContainingKey
146144if (!function_exists ('hasKeyValuePair ' )) {
147145 /**
148146 * Test if an array has both an key and value in parity with each other.
147+ *
149148 * @param mixed $key
150149 * @param mixed $value
151150 */
@@ -158,6 +157,7 @@ function hasKeyValuePair($key, $value): \Hamcrest\Arrays\IsArrayContainingKeyVal
158157if (!function_exists ('hasEntry ' )) {
159158 /**
160159 * Test if an array has both an key and value in parity with each other.
160+ *
161161 * @param mixed $key
162162 * @param mixed $value
163163 */
@@ -224,6 +224,7 @@ function nonEmptyTraversable(): \Hamcrest\Collection\IsEmptyTraversable
224224if (!function_exists ('traversableWithSize ' )) {
225225 /**
226226 * Does traversable size satisfy a given matcher?
227+ *
227228 * @param mixed $size
228229 */
229230 function traversableWithSize ($ size ): \Hamcrest \Collection \IsTraversableWithSize
@@ -306,7 +307,7 @@ function describedAs(/* args... */): \Hamcrest\Core\DescribedAs
306307
307308if (!function_exists ('everyItem ' )) {
308309 /**
309- * @param Matcher $itemMatcher
310+ * @param \Hamcrest\ Matcher $itemMatcher
310311 * A matcher to apply to every element in an array.
311312 *
312313 * @return \Hamcrest\Core\Every
@@ -322,6 +323,8 @@ function everyItem(\Hamcrest\Matcher $itemMatcher): \Hamcrest\Core\Every
322323 /**
323324 * Creates a matcher that matches any examined object whose <code>toString</code> or
324325 * <code>__toString()</code> method returns a value equalTo the specified string.
326+ *
327+ * @param mixed $matcher
325328 */
326329 function hasToString ($ matcher ): \Hamcrest \Core \HasToString
327330 {
@@ -336,6 +339,7 @@ function hasToString($matcher): \Hamcrest\Core\HasToString
336339 *
337340 * For example: assertThat($cheese, equalTo($smelly))
338341 * vs. assertThat($cheese, is(equalTo($smelly)))
342+ *
339343 * @param mixed $value
340344 */
341345 function is ($ value ): \Hamcrest \Core \Is
@@ -349,8 +353,6 @@ function is($value): \Hamcrest\Core\Is
349353 * This matcher always evaluates to true.
350354 *
351355 * @param string $description A meaningful string used when describing itself.
352- *
353- * @return \Hamcrest\Core\IsAnything
354356 */
355357 function anything (string $ description = 'ANYTHING ' ): \Hamcrest \Core \IsAnything
356358 {
@@ -397,6 +399,7 @@ function hasItems(/* args... */): \Hamcrest\Core\AllOf
397399 /**
398400 * Is the value equal to another value, as tested by the use of the "=="
399401 * comparison operator?
402+ *
400403 * @param mixed $item
401404 */
402405 function equalTo ($ item ): \Hamcrest \Core \IsEqual
@@ -408,6 +411,7 @@ function equalTo($item): \Hamcrest\Core\IsEqual
408411if (!function_exists ('identicalTo ' )) {
409412 /**
410413 * Tests of the value is identical to $value as tested by the "===" operator.
414+ *
411415 * @param mixed $value
412416 */
413417 function identicalTo ($ value ): \Hamcrest \Core \IsIdentical
@@ -445,6 +449,7 @@ function any(string $theClass): \Hamcrest\Core\IsInstanceOf
445449if (!function_exists ('not ' )) {
446450 /**
447451 * Matches if value does not match $value.
452+ *
448453 * @param mixed $value
449454 */
450455 function not ($ value ): \Hamcrest \Core \IsNot
@@ -492,6 +497,8 @@ function sameInstance($object): \Hamcrest\Core\IsSame
492497if (!function_exists ('typeOf ' )) {
493498 /**
494499 * Is the value a particular built-in type?
500+ *
501+ * @param string $theType
495502 */
496503 function typeOf (string $ theType ): \Hamcrest \Core \IsTypeOf
497504 {
@@ -502,6 +509,7 @@ function typeOf(string $theType): \Hamcrest\Core\IsTypeOf
502509if (!function_exists ('set ' )) {
503510 /**
504511 * Matches if value (class, object, or array) has named $property.
512+ *
505513 * @param mixed $property
506514 */
507515 function set ($ property ): \Hamcrest \Core \Set
@@ -513,6 +521,7 @@ function set($property): \Hamcrest\Core\Set
513521if (!function_exists ('notSet ' )) {
514522 /**
515523 * Matches if value (class, object, or array) does not have named $property.
524+ *
516525 * @param mixed $property
517526 */
518527 function notSet ($ property ): \Hamcrest \Core \Set
@@ -525,6 +534,7 @@ function notSet($property): \Hamcrest\Core\Set
525534 /**
526535 * Matches if value is a number equal to $value within some range of
527536 * acceptable error $delta.
537+ *
528538 * @param mixed $value
529539 * @param mixed $delta
530540 */
@@ -537,6 +547,7 @@ function closeTo($value, $delta): \Hamcrest\Number\IsCloseTo
537547if (!function_exists ('comparesEqualTo ' )) {
538548 /**
539549 * The value is not > $value, nor < $value.
550+ *
540551 * @param mixed $value
541552 */
542553 function comparesEqualTo ($ value ): \Hamcrest \Number \OrderingComparison
@@ -548,6 +559,7 @@ function comparesEqualTo($value): \Hamcrest\Number\OrderingComparison
548559if (!function_exists ('greaterThan ' )) {
549560 /**
550561 * The value is > $value.
562+ *
551563 * @param mixed $value
552564 */
553565 function greaterThan ($ value ): \Hamcrest \Number \OrderingComparison
@@ -559,6 +571,7 @@ function greaterThan($value): \Hamcrest\Number\OrderingComparison
559571if (!function_exists ('greaterThanOrEqualTo ' )) {
560572 /**
561573 * The value is >= $value.
574+ *
562575 * @param mixed $value
563576 */
564577 function greaterThanOrEqualTo ($ value ): \Hamcrest \Number \OrderingComparison
@@ -570,6 +583,7 @@ function greaterThanOrEqualTo($value): \Hamcrest\Number\OrderingComparison
570583if (!function_exists ('atLeast ' )) {
571584 /**
572585 * The value is >= $value.
586+ *
573587 * @param mixed $value
574588 */
575589 function atLeast ($ value ): \Hamcrest \Number \OrderingComparison
@@ -581,6 +595,7 @@ function atLeast($value): \Hamcrest\Number\OrderingComparison
581595if (!function_exists ('lessThan ' )) {
582596 /**
583597 * The value is < $value.
598+ *
584599 * @param mixed $value
585600 */
586601 function lessThan ($ value ): \Hamcrest \Number \OrderingComparison
@@ -592,6 +607,7 @@ function lessThan($value): \Hamcrest\Number\OrderingComparison
592607if (!function_exists ('lessThanOrEqualTo ' )) {
593608 /**
594609 * The value is <= $value.
610+ *
595611 * @param mixed $value
596612 */
597613 function lessThanOrEqualTo ($ value ): \Hamcrest \Number \OrderingComparison
@@ -603,6 +619,7 @@ function lessThanOrEqualTo($value): \Hamcrest\Number\OrderingComparison
603619if (!function_exists ('atMost ' )) {
604620 /**
605621 * The value is <= $value.
622+ *
606623 * @param mixed $value
607624 */
608625 function atMost ($ value ): \Hamcrest \Number \OrderingComparison
@@ -674,6 +691,7 @@ function nonEmptyString(): \Hamcrest\Text\IsEmptyString
674691if (!function_exists ('equalToIgnoringCase ' )) {
675692 /**
676693 * Matches if value is a string equal to $string, regardless of the case.
694+ *
677695 * @param mixed $string
678696 */
679697 function equalToIgnoringCase ($ string ): \Hamcrest \Text \IsEqualIgnoringCase
@@ -685,6 +703,7 @@ function equalToIgnoringCase($string): \Hamcrest\Text\IsEqualIgnoringCase
685703if (!function_exists ('equalToIgnoringWhiteSpace ' )) {
686704 /**
687705 * Matches if value is a string equal to $string, regardless of whitespace.
706+ *
688707 * @param mixed $string
689708 */
690709 function equalToIgnoringWhiteSpace ($ string ): \Hamcrest \Text \IsEqualIgnoringWhiteSpace
@@ -696,6 +715,7 @@ function equalToIgnoringWhiteSpace($string): \Hamcrest\Text\IsEqualIgnoringWhite
696715if (!function_exists ('matchesPattern ' )) {
697716 /**
698717 * Matches if value is a string that matches regular expression $pattern.
718+ *
699719 * @param mixed $pattern
700720 */
701721 function matchesPattern ($ pattern ): \Hamcrest \Text \MatchesPattern
@@ -707,6 +727,7 @@ function matchesPattern($pattern): \Hamcrest\Text\MatchesPattern
707727if (!function_exists ('containsString ' )) {
708728 /**
709729 * Matches if value is a string that contains $substring.
730+ *
710731 * @param mixed $substring
711732 */
712733 function containsString ($ substring ): \Hamcrest \Text \StringContains
@@ -718,6 +739,7 @@ function containsString($substring): \Hamcrest\Text\StringContains
718739if (!function_exists ('containsStringIgnoringCase ' )) {
719740 /**
720741 * Matches if value is a string that contains $substring regardless of the case.
742+ *
721743 * @param mixed $substring
722744 */
723745 function containsStringIgnoringCase ($ substring ): \Hamcrest \Text \StringContainsIgnoringCase
@@ -740,6 +762,7 @@ function stringContainsInOrder(/* args... */): \Hamcrest\Text\StringContainsInOr
740762if (!function_exists ('endsWith ' )) {
741763 /**
742764 * Matches if value is a string that ends with $substring.
765+ *
743766 * @param mixed $substring
744767 */
745768 function endsWith ($ substring ): \Hamcrest \Text \StringEndsWith
@@ -751,6 +774,7 @@ function endsWith($substring): \Hamcrest\Text\StringEndsWith
751774if (!function_exists ('startsWith ' )) {
752775 /**
753776 * Matches if value is a string that starts with $substring.
777+ *
754778 * @param mixed $substring
755779 */
756780 function startsWith ($ substring ): \Hamcrest \Text \StringStartsWith
@@ -904,10 +928,11 @@ function stringValue(): \Hamcrest\Type\IsString
904928 * Wraps <code>$matcher</code> with {@link Hamcrest\Core\IsEqual)
905929 * if it's not a matcher and the XPath in <code>count()</code>
906930 * if it's an integer.
931+ *
907932 * @param string $xpath
908933 * @param null|Matcher|int|mixed $matcher
909934 */
910- function hasXPath ($ xpath , $ matcher = null ): \Hamcrest \Xml \HasXPath
935+ function hasXPath (string $ xpath , $ matcher = null ): \Hamcrest \Xml \HasXPath
911936 {
912937 return \Hamcrest \Xml \HasXPath::hasXPath ($ xpath , $ matcher );
913938 }
0 commit comments