|
1 | 1 | # Asserts Module |
2 | 2 |
|
3 | 3 | **For additional reference, please review the [source](https://github.com/Codeception/Codeception/tree/master/src/Codeception/Module/Asserts.php)** |
| 4 | +## Codeception\Module\Asserts |
| 5 | + |
| 6 | +* *Extends* `Codeception\Module` |
| 7 | +* *Uses* `Codeception\Util\Shared\Asserts` |
4 | 8 |
|
5 | 9 | Special module for using asserts in your tests. |
6 | 10 |
|
7 | 11 | Class Asserts |
8 | 12 | @package Codeception\Module |
| 13 | +#### *public static* includeInheritedActionsBy setting it to false module wan't inherit methods of parent class. |
| 14 | + |
| 15 | + * `var` bool |
| 16 | +#### *public static* onlyActionsAllows to explicitly set what methods have this class. |
| 17 | + |
| 18 | + * `var` array |
| 19 | +#### *public static* excludeActionsAllows to explicitly exclude actions from module. |
| 20 | + |
| 21 | + * `var` array |
| 22 | +#### *public static* aliasesAllows to rename actions |
| 23 | + |
| 24 | + * `var` array |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | + |
9 | 31 |
|
10 | | -## Actions |
11 | 32 |
|
12 | | -### dontSeeContains |
13 | 33 |
|
14 | | -Checks that haystack doesn't contain needle. |
15 | 34 |
|
16 | | - * param $needle |
17 | | - * param $haystack |
18 | | - * param string $message |
19 | 35 |
|
20 | | -### dontSeeEmpty |
21 | 36 |
|
22 | | -Checks that variable is not empty. |
23 | 37 |
|
24 | | - * param $actual |
25 | | - * param string $message |
26 | 38 |
|
27 | | -### dontSeeEquals |
28 | 39 |
|
29 | | -Checks that two variables are not equal |
30 | 40 |
|
31 | | - * param $expected |
32 | | - * param $actual |
33 | | - * param string $message |
34 | 41 |
|
35 | | -### dontSeeNull |
36 | 42 |
|
37 | | -Checks that variable is not NULL |
38 | 43 |
|
39 | | - * param $actual |
40 | | - * param string $message |
41 | 44 |
|
42 | | -### fail |
43 | 45 |
|
44 | | -Fails the test with message. |
45 | 46 |
|
46 | | - * param $message |
47 | 47 |
|
48 | | -### seeContains |
49 | 48 |
|
50 | | -Checks that haystack contains needle |
51 | 49 |
|
52 | | - * param $needle |
53 | | - * param $haystack |
54 | | - * param string $message |
55 | 50 |
|
56 | | -### seeEmpty |
57 | 51 |
|
58 | | -Checks that variable is empty. |
59 | 52 |
|
60 | | - * param $actual |
61 | | - * param string $message |
62 | 53 |
|
63 | | -### seeEquals |
64 | 54 |
|
65 | | -Checks that two variables are equal. |
66 | 55 |
|
67 | | - * param $expected |
68 | | - * param $actual |
69 | | - * param string $message |
70 | 56 |
|
71 | | - * return mixed |
72 | 57 |
|
73 | | -### seeFalse |
74 | 58 |
|
75 | | -Checks that condition is negative. |
76 | 59 |
|
77 | | - * param $condition |
78 | | - * param string $message |
79 | 60 |
|
80 | | -### seeGreaterThen |
81 | 61 |
|
82 | | -Checks that expected is greater then actual |
83 | 62 |
|
84 | | - * param $expected |
85 | | - * param $actual |
86 | | - * param string $message |
87 | 63 |
|
| 64 | + |
| 65 | + |
| 66 | +### fail |
| 67 | +#### *public* fail($message)Fails the test with message. |
| 68 | + |
| 69 | + * `param` $message |
| 70 | +### seeEquals |
| 71 | +#### *public* seeEquals($expected, $actual, $message = null)Checks that two variables are equal. |
| 72 | + |
| 73 | + * `param` $expected |
| 74 | + * `param` $actual |
| 75 | + * `param` string $message |
| 76 | + |
| 77 | + * `return` mixed |
| 78 | +### dontSeeEquals |
| 79 | +#### *public* dontSeeEquals($expected, $actual, $message = null)Checks that two variables are not equal |
| 80 | + |
| 81 | + * `param` $expected |
| 82 | + * `param` $actual |
| 83 | + * `param` string $message |
| 84 | +### seeGreaterThen |
| 85 | +#### *public* seeGreaterThen($expected, $actual, $message = null)Checks that expected is greater then actual |
| 86 | + |
| 87 | + * `param` $expected |
| 88 | + * `param` $actual |
| 89 | + * `param` string $message |
88 | 90 | ### seeGreaterThenOrEqual |
| 91 | +#### *public* seeGreaterThenOrEqual($expected, $actual, $message = null)Checks that expected is greater or equal then actual |
89 | 92 |
|
90 | | -Checks that expected is greater or equal then actual |
| 93 | + * `param` $expected |
| 94 | + * `param` $actual |
| 95 | + * `param` string $message |
| 96 | +### seeContains |
| 97 | +#### *public* seeContains($needle, $haystack, $message = null)Checks that haystack contains needle |
91 | 98 |
|
92 | | - * param $expected |
93 | | - * param $actual |
94 | | - * param string $message |
| 99 | + * `param` $needle |
| 100 | + * `param` $haystack |
| 101 | + * `param` string $message |
| 102 | +### dontSeeContains |
| 103 | +#### *public* dontSeeContains($needle, $haystack, $message = null)Checks that haystack doesn't contain needle. |
95 | 104 |
|
96 | | -### seeNull |
| 105 | + * `param` $needle |
| 106 | + * `param` $haystack |
| 107 | + * `param` string $message |
| 108 | +### seeEmpty |
| 109 | +#### *public* seeEmpty($actual, $message = null)Checks that variable is empty. |
| 110 | + |
| 111 | + * `param` $actual |
| 112 | + * `param` string $message |
| 113 | +### dontSeeEmpty |
| 114 | +#### *public* dontSeeEmpty($actual, $message = null)Checks that variable is not empty. |
97 | 115 |
|
98 | | -Checks that variable is NULL |
| 116 | + * `param` $actual |
| 117 | + * `param` string $message |
| 118 | +### seeNull |
| 119 | +#### *public* seeNull($actual, $message = null)Checks that variable is NULL |
99 | 120 |
|
100 | | - * param $actual |
101 | | - * param string $message |
| 121 | + * `param` $actual |
| 122 | + * `param` string $message |
| 123 | +### dontSeeNull |
| 124 | +#### *public* dontSeeNull($actual, $message = null)Checks that variable is not NULL |
102 | 125 |
|
| 126 | + * `param` $actual |
| 127 | + * `param` string $message |
103 | 128 | ### seeTrue |
| 129 | +#### *public* seeTrue($condition, $message = null)Checks that condition is positive. |
104 | 130 |
|
105 | | -Checks that condition is positive. |
106 | | - |
107 | | - * param $condition |
108 | | - * param string $message |
| 131 | + * `param` $condition |
| 132 | + * `param` string $message |
| 133 | +### seeFalse |
| 134 | +#### *public* seeFalse($condition, $message = null)Checks that condition is negative. |
109 | 135 |
|
| 136 | + * `param` $condition |
| 137 | + * `param` string $message |
0 commit comments