Add support for replacing class synopses based on stubs

[kocsismate]

No description provided.

[kocsismate]

I've just submitted php/doc-en#839 for reference as well

[nikic]

Should this be in here? This looks unrelated to the comparison.

[kocsismate]

Yes, even though it makes the function have a side-effect, it's still absolutely required (I tried to clone $originalSynopsis before in order to prevent this, but it didn't work) :/

The reason why we need this code is that it attaches the $newSynopsis element to $doc by replacing $originalSynopsis.

[nikic]

Hm, would using DOMDocument::importNode work? Maybe it's possible to directly import it to $docComparator even?

[kocsismate]

I've just tried this:

$docComparator = new DOMDocument();
$docComparator->preserveWhiteSpace = false;
$docComparator->formatOutput = true;
$docComparator->loadXML('<root></root>');

$originalSynopsis = $docComparator->importNode($originalSynopsis, true);
$docComparator->documentElement->appendChild($originalSynopsis);
$xml1 = $docComparator->saveXML($originalSynopsis);

$newSynopsis = $docComparator->importNode($newSynopsis, true);
$docComparator->documentElement->appendChild($newSynopsis);
$newSynopsis->setAttribute("xmlns", "http://docbook.org/ns/docbook");
$xml2 = $docComparator->saveXML($newSynopsis);
$xml2 = getReplacedSynopsisXml($xml2);

return $xml1 === $xml2;

But it still doesn't disregard whitespace changes - I guess because $originalSynopsis keeps the whitespaces. As far as I see that's why we have to first convert the 2 DOMElements to strings, and then load them to the comparator.

[nikic]

Okay, let's stick with what you have then. Maybe rename the function to make it clear that it also modifies, something like replaceAndCompareXml()? Can't think of a great name...

[kocsismate]

replaceAndCompareXml() is not that bad of a name - I don't have any better suggestion.

[nikic]

Okay, let's stick with what you have then. Maybe rename the function to make it clear that it also modifies, something like replaceAndCompareXml()? Can't think of a great name...