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.

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

InnerBrowser.php: Deprecate deleteHeader in favor of unsetHeader #69

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Changes from all commits
Commits
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/Lib/InnerBrowser.php
Original file line number Diff line number Diff line change
Expand Up @@ -365,27 +365,35 @@ public function haveHttpHeader(string $name, string $value): void
}

/**
* Deletes the header with the passed name. Subsequent requests
* will not have the deleted header in its request.
* Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
* so that subsequent requests will not send it anymore.
*
* Example:
* ```php
* <?php
* $I->haveHttpHeader('X-Requested-With', 'Codeception');
* $I->amOnPage('test-headers.php');
* // ...
* $I->deleteHeader('X-Requested-With');
* $I->unsetHeader('X-Requested-With');
* $I->amOnPage('some-other-page.php');
* ```
*
* @param string $name the name of the header to delete.
* @param string $name the name of the header to unset.
*/
public function deleteHeader(string $name): void
public function unsetHeader(string $name): void
{
$name = implode('-', array_map('ucfirst', explode('-', strtolower(str_replace('_', '-', $name)))));
unset($this->headers[$name]);
}

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

public function amOnPage(string $page): void
{
$this->_loadPage('GET', $page);
Expand Down
Loading