Readability 3.0

[jtojnar]

Some BC breaking suggestions:

• Make all classes final.
• Properties private.
• Type hints everywhere.
• Decouple Readability (stateless worker object) from result?
• PHPStan level max.
• Drop JSLikeHTMLElement in favour of static functions?

[Kdecherf]

@jtojnar could you elaborate on 4th and 6th items?

[jtojnar]

Sure. I am not sure how feasible these are, though.

Decouple Readability (stateless worker object) from result

I was thinking something like making Readability a factory for an immutable ReadableArticle data object. That way it should be harder to have internally inconsistent state like in j0k3r/graby#307

Drop JSLikeHTMLElement in favour of static functions

registerNodeClass is hard to make work with static analysis – we could just create getInnerHtml(DOMElement): string function and use that instead ->innerHTML magic property.

[jtojnar]

Unfortunately, the JSLikeHTMLElement leaks to consumers like Graby in the public dom property and they may in turn leak it to their consumers. Though, fortunately, that does not currently appear to be the case with Graby, which only exposes the content as a string.

We might also want to switch to the new Dom API introduced in PHP 8.4, which supports innerHTML. But PHP 8.3 will continue to receive security updates until 31 Dec 2027 so that is probably way off.

I still think dropping the registerNodeClass should be fine for 3.0.