Skip to content

Commit

Permalink
Update REST.php
Browse files Browse the repository at this point in the history
See #22
  • Loading branch information
ThomasLandauer authored and W0rma committed Jul 11, 2024
1 parent 727823a commit 3846be9
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions src/Codeception/Module/REST.php
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ protected function getRunningClient(): AbstractBrowser
}

/**
* Sets a HTTP header to be used for all subsequent requests. Use [`deleteHeader`](#deleteHeader) to unset it.
* Sets a HTTP header to be used for all subsequent requests. Use [`unsetHttpHeader`](#unsetHttpHeader) to unset it.
*
* ```php
* <?php
Expand All @@ -218,7 +218,7 @@ public function haveHttpHeader(string $name, string $value): void
}

/**
* Deletes a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
* Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
* so that subsequent requests will not send it anymore.
*
* Example:
Expand All @@ -227,18 +227,26 @@ public function haveHttpHeader(string $name, string $value): void
* $I->haveHttpHeader('X-Requested-With', 'Codeception');
* $I->sendGet('test-headers.php');
* // ...
* $I->deleteHeader('X-Requested-With');
* $I->unsetHttpHeader('X-Requested-With');
* $I->sendPost('some-other-page.php');
* ```
*
* @param string $name the name of the header to delete.
* @param string $name the name of the header to unset.
* @part json
* @part xml
*/
public function deleteHeader(string $name): void
public function unsetHttpHeader(string $name): void
{
$this->connectionModule->deleteHeader($name);
}

/**
* @deprecated Use [unsetHttpHeader](#unsetHttpHeader) instead
*/
public function deleteHeader(string $name): void
{
$this->unsetHttpHeader($name);
}

/**
* Checks over the given HTTP header and (optionally)
Expand Down

0 comments on commit 3846be9

Please sign in to comment.