Skip to content

Commit 0ba49ce

Browse files
committed
Update module documentation
1 parent 3e0224a commit 0ba49ce

File tree

12 files changed

+290
-383
lines changed

12 files changed

+290
-383
lines changed

docs/modules/Laminas.md

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ public function seeResponseContains($text)
120120
{
121121
$this->assertStringContainsString($text, $this->getModule('Laminas')->_getResponseContent(), "response contains");
122122
}
123-
?>
124123

125124
{% endhighlight %}
126125

@@ -142,16 +141,12 @@ Useful for testing multi-step forms on a specific step.
142141
public function openCheckoutFormStep2($orderId) {
143142
$this->getModule('Laminas')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]);
144143
}
145-
?>
146144

147145
{% endhighlight %}
148146

149-
* `param` $method
150-
* `param` $uri
151-
* `param array` $parameters
152-
* `param array` $files
153-
* `param array` $server
154-
* `param null` $content
147+
* `param string` $method
148+
* `param string` $uri
149+
* `param string` $content
155150

156151

157152
#### _request
@@ -171,19 +166,15 @@ public function createUserByApi($name) {
171166
$user = json_decode($userData);
172167
return $user->id;
173168
}
174-
?>
175169

176170
{% endhighlight %}
177171
Does not load the response into the module so you can't interact with response page (click, fill forms).
178172
To load arbitrary page for interaction, use `_loadPage` method.
179173

180-
* `param` $method
181-
* `param` $uri
182-
* `param array` $parameters
183-
* `param array` $files
184-
* `param array` $server
185-
* `param null` $content
186-
* `return` mixed|Crawler
174+
* `param string` $method
175+
* `param string` $uri
176+
* `param string` $content
177+
* `return` string
187178
@throws ExternalUrlException
188179
@see `_loadPage`
189180

@@ -218,8 +209,8 @@ Adds service to a Laminas container
218209

219210
Authenticates user for HTTP_AUTH
220211

221-
* `param` $username
222-
* `param` $password
212+
* `param string` $username
213+
* `param string` $password
223214

224215

225216
#### amOnPage
@@ -338,7 +329,6 @@ $I->amOnPage('test-headers.php');
338329
// ...
339330
$I->deleteHeader('X-Requested-With');
340331
$I->amOnPage('some-other-page.php');
341-
?>
342332

343333
{% endhighlight %}
344334

@@ -614,7 +604,7 @@ $I->dontSeeResponseCodeIs(200);
614604
$I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
615605

616606
{% endhighlight %}
617-
* `param` $code
607+
* `param int` $code
618608

619609

620610
#### fillField
@@ -729,7 +719,6 @@ $aLinks = $I->grabMultiple('a', 'href');
729719
Grabs current page source code.
730720

731721
@throws ModuleException if no page was opened.
732-
733722
* `return` string Current page source code.
734723

735724

@@ -788,7 +777,6 @@ Example:
788777
<?php
789778
$I->haveHttpHeader('X-Requested-With', 'Codeception');
790779
$I->amOnPage('test-headers.php');
791-
?>
792780

793781
{% endhighlight %}
794782

@@ -801,7 +789,6 @@ should be represented as - 'Client&#x0005F;Id' or 'Client&#95;Id'
801789

802790
<?php
803791
$I->haveHttpHeader('Client&#95;Id', 'Codeception');
804-
?>
805792

806793
{% endhighlight %}
807794

@@ -819,8 +806,8 @@ Sets SERVER parameter valid for all next requests.
819806
$I->haveServerParameter('name', 'value');
820807

821808
{% endhighlight %}
822-
* `param` $name
823-
* `param` $value
809+
* `param string` $name
810+
* `param string` $value
824811

825812

826813
#### makeHtmlSnapshot
@@ -1213,15 +1200,15 @@ $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
12131200

12141201
{% endhighlight %}
12151202

1216-
* `param` $code
1203+
* `param int` $code
12171204

12181205

12191206
#### seeResponseCodeIsBetween
12201207

12211208
Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
12221209

1223-
* `param` $from
1224-
* `param` $to
1210+
* `param int` $from
1211+
* `param int` $to
12251212

12261213

12271214
#### seeResponseCodeIsClientError
@@ -1315,7 +1302,7 @@ $I->sendAjaxPostRequest('/add-task', ['form' => [
13151302
'category' => 'miscellaneous',
13161303
]]);
13171304

1318-
{% endhighlight %}
1305+
{% endhighlight %}
13191306

13201307
* `param string` $uri
13211308
* `param array` $params
@@ -1335,7 +1322,7 @@ $I->sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);
13351322

13361323
* `param` $method
13371324
* `param` $uri
1338-
* `param` $params
1325+
* `param array` $params
13391326

13401327

13411328
#### setCookie
@@ -1381,7 +1368,6 @@ this will remove old ones.
13811368
$I->setServerParameters([]);
13821369

13831370
{% endhighlight %}
1384-
* `param array` $params
13851371

13861372

13871373
#### startFollowingRedirects

docs/modules/Laravel.md

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,6 @@ public function seeResponseContains($text)
174174
{
175175
$this->assertStringContainsString($text, $this->getModule('Laravel')->_getResponseContent(), "response contains");
176176
}
177-
?>
178177

179178
{% endhighlight %}
180179

@@ -196,16 +195,12 @@ Useful for testing multi-step forms on a specific step.
196195
public function openCheckoutFormStep2($orderId) {
197196
$this->getModule('Laravel')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]);
198197
}
199-
?>
200198

201199
{% endhighlight %}
202200

203-
* `param` $method
204-
* `param` $uri
205-
* `param array` $parameters
206-
* `param array` $files
207-
* `param array` $server
208-
* `param null` $content
201+
* `param string` $method
202+
* `param string` $uri
203+
* `param string` $content
209204

210205

211206
#### _request
@@ -225,19 +220,15 @@ public function createUserByApi($name) {
225220
$user = json_decode($userData);
226221
return $user->id;
227222
}
228-
?>
229223

230224
{% endhighlight %}
231225
Does not load the response into the module so you can't interact with response page (click, fill forms).
232226
To load arbitrary page for interaction, use `_loadPage` method.
233227

234-
* `param` $method
235-
* `param` $uri
236-
* `param array` $parameters
237-
* `param array` $files
238-
* `param array` $server
239-
* `param null` $content
240-
* `return` mixed|Crawler
228+
* `param string` $method
229+
* `param string` $uri
230+
* `param string` $content
231+
* `return` string
241232
@throws ExternalUrlException
242233
@see `_loadPage`
243234

@@ -260,8 +251,8 @@ $this->getModule('Laravel')->_savePageSource(codecept_output_dir().'page.html');
260251

261252
Authenticates user for HTTP_AUTH
262253

263-
* `param` $username
264-
* `param` $password
254+
* `param string` $username
255+
* `param string` $password
265256

266257

267258
#### amLoggedAs
@@ -449,7 +440,6 @@ $I->amOnPage('test-headers.php');
449440
// ...
450441
$I->deleteHeader('X-Requested-With');
451442
$I->amOnPage('some-other-page.php');
452-
?>
453443

454444
{% endhighlight %}
455445

@@ -828,7 +818,7 @@ $I->dontSeeResponseCodeIs(200);
828818
$I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
829819

830820
{% endhighlight %}
831-
* `param` $code
821+
* `param int` $code
832822

833823

834824
#### enableExceptionHandling
@@ -981,7 +971,6 @@ $I->grabNumRecords('App\Models\User', ['name' => 'davert']);
981971
Grabs current page source code.
982972

983973
@throws ModuleException if no page was opened.
984-
985974
* `return` string Current page source code.
986975

987976

@@ -1142,7 +1131,6 @@ Example:
11421131
<?php
11431132
$I->haveHttpHeader('X-Requested-With', 'Codeception');
11441133
$I->amOnPage('test-headers.php');
1145-
?>
11461134

11471135
{% endhighlight %}
11481136

@@ -1155,7 +1143,6 @@ should be represented as - 'Client&#x0005F;Id' or 'Client&#95;Id'
11551143

11561144
<?php
11571145
$I->haveHttpHeader('Client&#95;Id', 'Codeception');
1158-
?>
11591146

11601147
{% endhighlight %}
11611148

@@ -1231,8 +1218,8 @@ Sets SERVER parameter valid for all next requests.
12311218
$I->haveServerParameter('name', 'value');
12321219

12331220
{% endhighlight %}
1234-
* `param` $name
1235-
* `param` $value
1221+
* `param string` $name
1222+
* `param string` $value
12361223

12371224

12381225
#### haveSingleton
@@ -1845,15 +1832,15 @@ $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
18451832

18461833
{% endhighlight %}
18471834

1848-
* `param` $code
1835+
* `param int` $code
18491836

18501837

18511838
#### seeResponseCodeIsBetween
18521839

18531840
Checks that response code is between a certain range. Between actually means [from <= CODE <= to]
18541841

1855-
* `param` $from
1856-
* `param` $to
1842+
* `param int` $from
1843+
* `param int` $to
18571844

18581845

18591846
#### seeResponseCodeIsClientError
@@ -1962,7 +1949,7 @@ $I->sendAjaxPostRequest('/add-task', ['form' => [
19621949
'category' => 'miscellaneous',
19631950
]]);
19641951

1965-
{% endhighlight %}
1952+
{% endhighlight %}
19661953

19671954
* `param string` $uri
19681955
* `param array` $params
@@ -1982,7 +1969,7 @@ $I->sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);
19821969

19831970
* `param` $method
19841971
* `param` $uri
1985-
* `param` $params
1972+
* `param array` $params
19861973

19871974

19881975
#### setApplication
@@ -2033,7 +2020,6 @@ this will remove old ones.
20332020
$I->setServerParameters([]);
20342021

20352022
{% endhighlight %}
2036-
* `param array` $params
20372023

20382024

20392025
#### startFollowingRedirects

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy