Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add unsetHttpHeader() + deprecate deleteHeader() #106

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Add unsetHttpHeader() + deprecate deleteHeader() #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions src/Codeception/Module/REST.php
View file
Open in desktop
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
Loading