Bug: Wrong @deprecrated annotation in HTTP/Request.php For getMethod()

[donpwinston]

PHP Version

8.2

CodeIgniter4 Version

4.3.1

CodeIgniter4 Installation Method

Composer (using codeigniter4/appstarter)

Which operating systems have you tested for this bug?

macOS

Which server did you use?

apache

Database

No response

What happened?

My VS Code DeveSenses extension flags $request->getMethod() as an error because the entire method is marked as deprecated. Actually only the optional parameter bool $upper is deprecated. I believe the correct way to annotate this is the following:

remove the line "@deprecated The $upper functionality will be removed and this will revert to its PSR-7 equivalent"

Add * #[Deprecated] above the line " * @param bool $upper Whether to return in upper or lower case."

Steps to Reproduce

Install the DevSenses VS Code extension.

Expected Output

No underline for the text getMethod() in your code.

Anything else?

No response

[kenjis]

Thank you for reporting.

What is DeveSenses extension?
The purpose of the @deprecrated annotation is to inform that the optional parameter is deprecated to developers.
The way you show can inform it to devs who don't use the extension?

[donpwinston]

https://www.devsense.com/en The devsense engineer told me he thinks the following is the proper way to do it. ...* #[Deprecated]* @param bool $upper Whether to return in upper or lower case.... The way it is done now indicates the entire method is deprecated which is not the case. On Sunday, March 5, 2023 at 05:47:38 PM EST, kenjis ***@***.***> wrote: Thank you for reporting. What is DeveSenses extension? The purpose of the @deprecrated annotation is to inform that the optional parameter is deprecated to developers. The way you show can inform it to devs who don't use the extension? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: ***@***.***>

[kenjis]

I don't use DeveSenses.

Do you mean the following? It causes Undefined Type.

And it does not inform me the deprecation.

[donpwinston]

No. You need to put it in the comment area:     /**     * Get the request method.     * #[Deprecated]     * @param bool $upper Whether to return in upper or lower case.     *     *     * @codeCoverageIgnore     */    public function getMethod(bool $upper = false): string   {      return ($upper) ? strtoupper($this->method) : strtolower($this->method);   } On Sunday, March 5, 2023 at 07:52:00 PM EST, kenjis ***@***.***> wrote: I don't use DeveSenses. Do you mean the following? It causes Undefined Type. And it does not inform me the deprecation. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: ***@***.***>

[paulbalandan]

The #[Deprecated] attribute is still an RFC. See https://wiki.php.net/rfc/deprecated_attribute. So I'm not sure if the placement of the attribute actually "works".

[donpwinston]

ok. Then just remove the @deprecated annotation. On Monday, March 6, 2023 at 10:20:25 AM EST, John Paul E. Balandan, CPA ***@***.***> wrote: The #[Deprecated] attribute is still an RFC. See https://wiki.php.net/rfc/deprecated_attribute. So I'm not sure if the placement of the attribute actually "works". — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: ***@***.***>

[kenjis]

This is intentional.

If there is a better way to let devs know that that parameter is deprecated,
which is supported by most of the IDEs, please send PR.