PHP 8.2: explicitly declare properties

[jrfnl]

Context

Dynamic (non-explicitly declared) property usage is expected to be deprecated as of PHP 8.2 and will become a fatal error in PHP 9.0.

There are a number of ways to mitigate this:

• If it's an accidental typo for a declared property: fix the typo.
• For known properties: declare them on the class.
• For unknown properties: add the magic __get(), __set() et al methods to the class or let the class extend stdClass which has highly optimized versions of these magic methods build in.
• For unknown use of dynamic properties, the #[AllowDynamicProperties] attribute can be added to the class. The attribute will automatically be inherited by child classes.

Refs:

• https://wiki.php.net/rfc/deprecate_dynamic_properties

Commits

Locator: explicitly declare all properties

In this case, the $dom property is referenced multiple times throughout this class, so falls in the "known property" category.

Sanitize: explicitly declare all properties

In this case, the $registry property is referenced multiple times throughout this class, so falls in the "known property" category.

Autoloader: explicitly declare all properties

In this case, the $path property is referenced a couple of times throughout this class, so falls in the "known property" category.

🆕 SimplePie_Cache_Redis: fix bug for using undefined property

The $ttl property is not declared, not set on this cache, nor its parent, which means that it would always be passed as null.

As the call to the Redis::expire() method is within a if ($this->options['expire']) condition and a similar call to the Redis::expire() method in the SimplePie_Cache_Redis::save() method, also uses $this->options['expire'] for the "ttl" value, changing the passed parameter to $this->options['expire'] seems the correct fix.

QA

The existing unit tests already cover these changes.

A scan with @exakat reveals one more issue, but I'm not sure how to fix that one:

The SimplePie_Cache_Redis::touch() method refers to (uses) a $ttl property, but this property is not declared on the class, nor set anywhere, so it is unclear what the value of the property should be when explicitly declaring it on the class.

[jtojnar]

I think $this->ttl was supposed to be $this->options['expire'] – see the other instance of Redis::expire method being called.

[jrfnl]

@jtojnar

I think $this->ttl was supposed to be $this->options['expire'] – see the other instance of Redis::expire method being called.

Good call, makes perfect sense. I've added an extra commit to address this.

[jtojnar]

I am surprised var is still allowed in PHP 8, GitHub syntax highlighter does not seem to know it 🤣

[mblaney]

thanks @jrfnl

[jrfnl]

I am surprised var is still allowed in PHP 8, GitHub syntax highlighter does not seem to know it 🤣

It is, though it is highly recommended to use visibility modifiers instead. Happy to change that throughout the codebase, but that was out of scope for this PR.