Skip to content

Add NoDiscard attribute for Uri::with*() and Url::with*() methods #20209

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

Open
wants to merge 1 commit into
base: PHP-8.5
Choose a base branch
from
+151 −11
Open

Add NoDiscard attribute for Uri::with*() and Url::with*() methods #20209

Show file tree
Hide file tree
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
15 changes: 15 additions & 0 deletions ext/uri/php_uri.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,14 @@ public function getScheme(): ?string {}

public function getRawScheme(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withScheme() does not modify the object itself")]
public function withScheme(?string $scheme): static {}

public function getUserInfo(): ?string {}

public function getRawUserInfo(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withUserInfo() does not modify the object itself")]
public function withUserInfo(#[\SensitiveParameter] ?string $userinfo): static {}

public function getUsername(): ?string {}
Expand All @@ -57,28 +59,33 @@ public function getHost(): ?string {}

public function getRawHost(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withHost() does not modify the object itself")]
public function withHost(?string $host): static {}

public function getPort(): ?int {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withPort() does not modify the object itself")]
public function withPort(?int $port): static {}

public function getPath(): string {}

public function getRawPath(): string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withPath() does not modify the object itself")]
public function withPath(string $path): static {}

public function getQuery(): ?string {}

public function getRawQuery(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withQuery() does not modify the object itself")]
public function withQuery(?string $query): static {}

public function getFragment(): ?string {}

public function getRawFragment(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withFragment() does not modify the object itself")]
public function withFragment(?string $fragment): static {}

public function equals(\Uri\Rfc3986\Uri $uri, \Uri\UriComparisonMode $comparisonMode = \Uri\UriComparisonMode::ExcludeFragment): bool {}
Expand Down Expand Up @@ -160,47 +167,55 @@ public function __construct(string $uri, ?\Uri\WhatWg\Url $baseUrl = null, &$sof

public function getScheme(): string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withScheme() does not modify the object itself")]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This message is referring to the wrong class (same below).

public function withScheme(string $scheme): static {}

/** @implementation-alias Uri\Rfc3986\Uri::getUsername */
public function getUsername(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withUsername() does not modify the object itself")]
public function withUsername(?string $username): static {}

/** @implementation-alias Uri\Rfc3986\Uri::getPassword */
public function getPassword(): ?string {}

#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withPassword() does not modify the object itself")]
public function withPassword(#[\SensitiveParameter] ?string $password): static {}

public function getAsciiHost(): ?string {}

public function getUnicodeHost(): ?string {}

/** @implementation-alias Uri\Rfc3986\Uri::withHost */
#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withHost() does not modify the object itself")]
public function withHost(?string $host): static {}

/** @implementation-alias Uri\Rfc3986\Uri::getPort */
public function getPort(): ?int {}

/** @implementation-alias Uri\Rfc3986\Uri::withPort */
#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withPort() does not modify the object itself")]
public function withPort(?int $port): static {}

/** @implementation-alias Uri\Rfc3986\Uri::getPath */
public function getPath(): string {}

/** @implementation-alias Uri\Rfc3986\Uri::withPath */
#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withPath() does not modify the object itself")]
public function withPath(string $path): static {}

/** @implementation-alias Uri\Rfc3986\Uri::getQuery */
public function getQuery(): ?string {}

/** @implementation-alias Uri\Rfc3986\Uri::withQuery */
#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withQuery() does not modify the object itself")]
public function withQuery(?string $query): static {}

/** @implementation-alias Uri\Rfc3986\Uri::getFragment */
public function getFragment(): ?string {}

/** @implementation-alias Uri\Rfc3986\Uri::withFragment */
#[\NoDiscard(message: "as Uri\Rfc3986\Uri::withFragment() does not modify the object itself")]
public function withFragment(?string $fragment): static {}

public function equals(\Uri\WhatWg\Url $url, \Uri\UriComparisonMode $comparisonMode = \Uri\UriComparisonMode::ExcludeFragment): bool {}
Expand Down
Loading
Loading