chore: Remove @deprecated annotation from config array fields

[jeromegamez]

When running PHPStan with the https://github.com/phpstan/phpstan-deprecation-rules/ extension installed, the whole method is seen as deprecated, leading to violations like in https://github.com/kreait/firebase-php/actions/runs/18822790410/job/53700886141

Call to deprecated method __construct() of class Google\Cloud\Storage\StorageClient:
This option is being deprecated because of a potential security risk.

When hovering about the constructor in PHPStorm, the constructor itself is marked as deprecated as well (here in the FirestoreClient):

I don't know if this an authoritative source, but https://docs.phpdoc.org/guide/references/phpdoc/tags/deprecated.html mentions that @deprecated applies to structural elements - I'm not aware that one is supposed to use it to deprecate fields in an array with this.

PS: I couldn't find a source for @type "being a thing" 🙈

[bshaffer]

When running PHPStan... the whole method is seen as deprecated

Well that's unfortunate. I checked using IntelliPHPence, and didn't have this issue. I wonder if there's a way to fix this for PHPStan without removing it, as i really would like to keep it there.

PS: I couldn't find a source for @type "being a thing" 🙈

PHPStan is only one standardization around documenting PHP methods/array shapes, and at the time this library was written, the documentation standard being used here (@type) was all we could find.

[bshaffer]

Can you try using this syntax and see if it works (prefixing @deprecated with //)? This should tell PHPStan to ignore that line (e.g. treat it as a comment rather than parse the tag)

Suggested change

	* This option is being deprecated because of a potential security risk.
	* // @deprecated
	* This option is being deprecated because of a potential security risk.

[jeromegamez]

Unfortunately, this didn't change the report (I think because it's just™ a comment within a comment).

In a project, you can add this to silence the error:

/* @phpstan-ignore method.deprecated */
$client = new FirestoreClient($config);

(only when they use https://github.com/phpstan/phpstan-deprecation-rules )

[jeromegamez]

When running PHPStan... the whole method is seen as deprecated

Well that's unfortunate. I checked using IntelliPHPence, and didn't have this issue. I wonder if there's a way to fix this for PHPStan without removing it, as i really would like to keep it there.

It's only when using https://github.com/phpstan/phpstan-deprecation-rules - "vanilla" PHPStan doesn't report this. People can still ignore this specific error in their own projects, they'd have to add a /* @phpstan-ignore method.deprecated */ where they call the constructor.

But aside from PHPStan, my IDE shows the constructor as deprecated as well (see screenshot above) - do you know if other IDEs/Doc tools can parse the docblock as intendend and only deprecate the array key? Otherwise I'd still like to suggest removing it and keeping only the [Deprecated] as an indicator. IDEs do parse the annotation, and - in the case of PHPStorm - it looks as if they only check if @deprecated is somewhere inside the docblock, not explicitly at the "root" level

/**
 * @deprecated
 */

[bshaffer]

But aside from PHPStan, my IDE shows the constructor as deprecated as well

Ahh you're right, I missed that. I don't like that at all

I'd still like to suggest removing it and keeping only the [Deprecated] as an indicator.

This seems like a good idea

[Hectorhammett]

Makes perfect sense. I wish there was a better way to really alert the end user with the deprecated parameter, but I feel like this is a weakness of using untyped arrays for the options. Leaving the DEPRECATED message seems like a good compromise to me.