From 84c53ee75296d75e0a99814536978d1300137823 Mon Sep 17 00:00:00 2001 From: Thomas Landauer Date: Fri, 12 Jul 2024 15:29:12 +0200 Subject: [PATCH] Update InnerBrowser.php: Deprecate `deleteHeader` in favor of `unsetHeader` As announced at https://github.com/Codeception/module-rest/issues/22#issuecomment-708569043 The PR is kindof the same as https://github.com/Codeception/module-rest/pull/106 --- src/Codeception/Lib/InnerBrowser.php | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/src/Codeception/Lib/InnerBrowser.php b/src/Codeception/Lib/InnerBrowser.php index f124345..63a5801 100644 --- a/src/Codeception/Lib/InnerBrowser.php +++ b/src/Codeception/Lib/InnerBrowser.php @@ -365,8 +365,8 @@ 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 @@ -374,18 +374,26 @@ public function haveHttpHeader(string $name, string $value): void * $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);