Skip to content

Commit 19f37fc

Browse files
github-actions[bot]github-actions[bot]
github-actions[bot]
authored and
github-actions[bot]
committed
updated
1 parent cd3eded commit 19f37fc

File tree

7 files changed

+161
-112
lines changed

7 files changed

+161
-112
lines changed

‎docs/modules/Laminas.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -328,24 +328,10 @@ $I->click(['link' => 'Login']);
328328

329329
#### deleteHeader
330330

331-
* `param string` $name the name of the header to delete.
331+
@deprecated
332+
* `param string` $name
332333
* `return void`
333334

334-
Deletes the header with the passed name. Subsequent requests
335-
will not have the deleted header in its request.
336-
337-
Example:
338-
{% highlight php %}
339-
340-
<?php
341-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
342-
$I->amOnPage('test-headers.php');
343-
// ...
344-
$I->deleteHeader('X-Requested-With');
345-
$I->amOnPage('some-other-page.php');
346-
347-
{% endhighlight %}
348-
349335

350336
#### dontSee
351337

@@ -1692,4 +1678,25 @@ $I->uncheckOption('#notify');
16921678
16931679
{% endhighlight %}
16941680
1681+
1682+
#### unsetHeader
1683+
1684+
* `param string` $name the name of the header to unset.
1685+
* `return void`
1686+
1687+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
1688+
so that subsequent requests will not send it anymore.
1689+
1690+
Example:
1691+
{% highlight php %}
1692+
1693+
<?php
1694+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
1695+
$I->amOnPage('test-headers.php');
1696+
// ...
1697+
$I->unsetHeader('X-Requested-With');
1698+
$I->amOnPage('some-other-page.php');
1699+
1700+
{% endhighlight %}
1701+
16951702
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-laminas/tree/master/src/Codeception/Module/Laminas.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Laravel.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -513,24 +513,10 @@ $I->click(['link' => 'Login']);
513513

514514
#### deleteHeader
515515

516-
* `param string` $name the name of the header to delete.
516+
@deprecated
517+
* `param string` $name
517518
* `return void`
518519

519-
Deletes the header with the passed name. Subsequent requests
520-
will not have the deleted header in its request.
521-
522-
Example:
523-
{% highlight php %}
524-
525-
<?php
526-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
527-
$I->amOnPage('test-headers.php');
528-
// ...
529-
$I->deleteHeader('X-Requested-With');
530-
$I->amOnPage('some-other-page.php');
531-
532-
{% endhighlight %}
533-
534520

535521
#### disableEvents
536522

@@ -2589,4 +2575,25 @@ $I->uncheckOption('#notify');
25892575
25902576
{% endhighlight %}
25912577
2578+
2579+
#### unsetHeader
2580+
2581+
* `param string` $name the name of the header to unset.
2582+
* `return void`
2583+
2584+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
2585+
so that subsequent requests will not send it anymore.
2586+
2587+
Example:
2588+
{% highlight php %}
2589+
2590+
<?php
2591+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
2592+
$I->amOnPage('test-headers.php');
2593+
// ...
2594+
$I->unsetHeader('X-Requested-With');
2595+
$I->amOnPage('some-other-page.php');
2596+
2597+
{% endhighlight %}
2598+
25922599
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-laravel/tree/master/src/Codeception/Module/Laravel.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Lumen.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -330,24 +330,10 @@ $I->click(['link' => 'Login']);
330330

331331
#### deleteHeader
332332

333-
* `param string` $name the name of the header to delete.
333+
@deprecated
334+
* `param string` $name
334335
* `return void`
335336

336-
Deletes the header with the passed name. Subsequent requests
337-
will not have the deleted header in its request.
338-
339-
Example:
340-
{% highlight php %}
341-
342-
<?php
343-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
344-
$I->amOnPage('test-headers.php');
345-
// ...
346-
$I->deleteHeader('X-Requested-With');
347-
$I->amOnPage('some-other-page.php');
348-
349-
{% endhighlight %}
350-
351337

352338
#### dontSee
353339

@@ -1978,4 +1964,25 @@ $I->uncheckOption('#notify');
19781964
19791965
{% endhighlight %}
19801966
1967+
1968+
#### unsetHeader
1969+
1970+
* `param string` $name the name of the header to unset.
1971+
* `return void`
1972+
1973+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
1974+
so that subsequent requests will not send it anymore.
1975+
1976+
Example:
1977+
{% highlight php %}
1978+
1979+
<?php
1980+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
1981+
$I->amOnPage('test-headers.php');
1982+
// ...
1983+
$I->unsetHeader('X-Requested-With');
1984+
$I->amOnPage('some-other-page.php');
1985+
1986+
{% endhighlight %}
1987+
19811988
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-lumen/tree/master/src/Codeception/Module/Lumen.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Mezzio.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -274,24 +274,10 @@ $I->click(['link' => 'Login']);
274274

275275
#### deleteHeader
276276

277-
* `param string` $name the name of the header to delete.
277+
@deprecated
278+
* `param string` $name
278279
* `return void`
279280

280-
Deletes the header with the passed name. Subsequent requests
281-
will not have the deleted header in its request.
282-
283-
Example:
284-
{% highlight php %}
285-
286-
<?php
287-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
288-
$I->amOnPage('test-headers.php');
289-
// ...
290-
$I->deleteHeader('X-Requested-With');
291-
$I->amOnPage('some-other-page.php');
292-
293-
{% endhighlight %}
294-
295281

296282
#### dontSee
297283

@@ -1604,4 +1590,25 @@ $I->uncheckOption('#notify');
16041590
16051591
{% endhighlight %}
16061592
1593+
1594+
#### unsetHeader
1595+
1596+
* `param string` $name the name of the header to unset.
1597+
* `return void`
1598+
1599+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
1600+
so that subsequent requests will not send it anymore.
1601+
1602+
Example:
1603+
{% highlight php %}
1604+
1605+
<?php
1606+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
1607+
$I->amOnPage('test-headers.php');
1608+
// ...
1609+
$I->unsetHeader('X-Requested-With');
1610+
$I->amOnPage('some-other-page.php');
1611+
1612+
{% endhighlight %}
1613+
16071614
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-mezzio/tree/master/src/Codeception/Module/Mezzio.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/PhpBrowser.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -354,24 +354,10 @@ $I->click(['link' => 'Login']);
354354

355355
#### deleteHeader
356356

357-
* `param string` $name the name of the header to delete.
357+
@deprecated
358+
* `param string` $name
358359
* `return void`
359360

360-
Deletes the header with the passed name. Subsequent requests
361-
will not have the deleted header in its request.
362-
363-
Example:
364-
{% highlight php %}
365-
366-
<?php
367-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
368-
$I->amOnPage('test-headers.php');
369-
// ...
370-
$I->deleteHeader('X-Requested-With');
371-
$I->amOnPage('some-other-page.php');
372-
373-
{% endhighlight %}
374-
375361

376362
#### dontSee
377363

@@ -1717,4 +1703,25 @@ $I->uncheckOption('#notify');
17171703
17181704
{% endhighlight %}
17191705
1706+
1707+
#### unsetHeader
1708+
1709+
* `param string` $name the name of the header to unset.
1710+
* `return void`
1711+
1712+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
1713+
so that subsequent requests will not send it anymore.
1714+
1715+
Example:
1716+
{% highlight php %}
1717+
1718+
<?php
1719+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
1720+
$I->amOnPage('test-headers.php');
1721+
// ...
1722+
$I->unsetHeader('X-Requested-With');
1723+
$I->amOnPage('some-other-page.php');
1724+
1725+
{% endhighlight %}
1726+
17201727
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-phpbrowser/tree/master/src/Codeception/Module/PhpBrowser.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Symfony.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -578,24 +578,10 @@ $I->click(['link' => 'Login']);
578578

579579
#### deleteHeader
580580

581-
* `param string` $name the name of the header to delete.
581+
@deprecated
582+
* `param string` $name
582583
* `return void`
583584

584-
Deletes the header with the passed name. Subsequent requests
585-
will not have the deleted header in its request.
586-
587-
Example:
588-
{% highlight php %}
589-
590-
<?php
591-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
592-
$I->amOnPage('test-headers.php');
593-
// ...
594-
$I->deleteHeader('X-Requested-With');
595-
$I->amOnPage('some-other-page.php');
596-
597-
{% endhighlight %}
598-
599585

600586
#### dontSee
601587

@@ -2846,4 +2832,25 @@ $I->uncheckOption('#notify');
28462832
28472833
Remove service $serviceName from the lists of persistent services.
28482834
2835+
2836+
#### unsetHeader
2837+
2838+
* `param string` $name the name of the header to unset.
2839+
* `return void`
2840+
2841+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
2842+
so that subsequent requests will not send it anymore.
2843+
2844+
Example:
2845+
{% highlight php %}
2846+
2847+
<?php
2848+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
2849+
$I->amOnPage('test-headers.php');
2850+
// ...
2851+
$I->unsetHeader('X-Requested-With');
2852+
$I->amOnPage('some-other-page.php');
2853+
2854+
{% endhighlight %}
2855+
28492856
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-symfony/tree/master/src/Codeception/Module/Symfony.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Yii2.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -451,24 +451,10 @@ Creates the CSRF Cookie.
451451

452452
#### deleteHeader
453453

454-
* `param string` $name the name of the header to delete.
454+
@deprecated
455+
* `param string` $name
455456
* `return void`
456457

457-
Deletes the header with the passed name. Subsequent requests
458-
will not have the deleted header in its request.
459-
460-
Example:
461-
{% highlight php %}
462-
463-
<?php
464-
$I->haveHttpHeader('X-Requested-With', 'Codeception');
465-
$I->amOnPage('test-headers.php');
466-
// ...
467-
$I->deleteHeader('X-Requested-With');
468-
$I->amOnPage('some-other-page.php');
469-
470-
{% endhighlight %}
471-
472458

473459
#### dontSee
474460

@@ -2009,4 +1995,25 @@ $I->uncheckOption('#notify');
20091995
20101996
{% endhighlight %}
20111997
1998+
1999+
#### unsetHeader
2000+
2001+
* `param string` $name the name of the header to unset.
2002+
* `return void`
2003+
2004+
Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
2005+
so that subsequent requests will not send it anymore.
2006+
2007+
Example:
2008+
{% highlight php %}
2009+
2010+
<?php
2011+
$I->haveHttpHeader('X-Requested-With', 'Codeception');
2012+
$I->amOnPage('test-headers.php');
2013+
// ...
2014+
$I->unsetHeader('X-Requested-With');
2015+
$I->amOnPage('some-other-page.php');
2016+
2017+
{% endhighlight %}
2018+
20122019
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-yii2/tree/master/src/Codeception/Module/Yii2.php">Help us to improve documentation. Edit module reference</a></div>

0 commit comments

Comments
 (0)