Warn about missing class synopses when running gen_stub.php --replace-classsynopses

[kocsismate]

Running ./build/gen_stub.php --replace-classsynopses ./ ../doc-en/ locally shows the following output now:

Warning: Missing class synopsis page for Attribute
Warning: Missing class synopsis page for ReturnTypeWillChange
Warning: Missing class synopsis page for AllowDynamicProperties
Warning: Missing class synopsis page for SensitiveParameter
Warning: Missing class synopsis page for SensitiveParameterValue
Warning: Missing class synopsis page for ClosedGeneratorException
Warning: Missing class synopsis page for InternalIterator
Warning: Missing class synopsis page for com_safearray_proxy
Warning: Missing class synopsis page for DOMNameSpaceNode
Warning: Missing class synopsis page for LibXMLError
Warning: Missing class synopsis page for PDORow
Warning: Missing class synopsis page for Random\Engine\Mt19937
Warning: Missing class synopsis page for Random\Engine\PcgOneseq128XslRr64
Warning: Missing class synopsis page for Random\Engine\Xoshiro256StarStar
Warning: Missing class synopsis page for Random\Engine\Secure
Warning: Missing class synopsis page for Random\Engine
Warning: Missing class synopsis page for Random\CryptoSafeEngine
Warning: Missing class synopsis page for Random\Randomizer
Warning: Missing class synopsis page for Random\RandomError
Warning: Missing class synopsis page for Random\BrokenRandomEngineError
Warning: Missing class synopsis page for Random\RandomException
Warning: Missing class synopsis page for XMLParser

Do we want to document the Attribute classes themselves? if not, I'll exclude them too.

[cmb69]

Thank you! This looks really helpful.

Warning: Missing class synopsis page for XMLParser

Hmm, https://www.php.net/manual/en/class.xmlparser.php is there.

Do we want to document the Attribute classes themselves?

In my opinion, we should.

[cmb69]

Warning: Missing class synopsis page for PDORow

What's that?

[kocsismate]

Hmm, https://www.php.net/manual/en/class.xmlparser.php is there.

php/doc-en#1795

In my opinion, we should.

Agreed!

What's that?

According to bf48daa, it seems like that this class is for some short of laziness. I'm not really sure if it really works because there is no meaningful test for it.

[cmb69]

According to bf48daa, it seems like that this class is for some short of laziness.

Ah, thanks! So this is a support class for PDO::FETCH_LAZY; looks like there are some tests for that. Anyhow, I think it's good to document class, so we can clarify that it should not be used in userland code (which is fortunately already forbidden).

[kocsismate]

I slightly changed the implementation: now, the validation is only shown when the --verify flag is set. This is because otherwise false-positive warnings might be emitted when class synopses in a specific subdirectory are the target, like below:

 ./build/gen_stub.php --replace-classsynopses ./ext/reflection ./Zend ../doc-en/reference/reflection

The input arguments have to cover all members of the targeted class hierarchy (thus we need to include ./Zend as well), and in this case, no class synopsis page of any Zend classes would be found. In order to prevent such scenarios, I think it's a good idea to be able to opt into the validation.

[cmb69]

Thank you!

now, the validation is only shown when the --verify flag is set.

Good idea!