Ability to apply XSL style sheet to Template

Sometimes we need to perform more complex actions with document template than just simple replace of ${} parameters. XSLT really helps in such situations.

This issue is a proposal of the correspondent class method implementation with the followed signature.

/**
 * Applies XSL style sheet to XML template.
 *
 * @param DOMDocument &$xslDOMDocument
 * @param array $xslOptions = array()
 * @param string $xslOptionsURI = ''
 */
public function applyXslStyleSheet(&$xslDOMDocument, $xslOptions = array(), $xslOptionsURI = '')
{
    ...
}

Assumption: we have XSL style sheet loaded as DOMDocument before the method call.
Requirement: "php_xml.dll" library.
Limitation: XSLT 1.0, XPath 1.0 (because of XSLTProcessor).

[Progi1984]

Could you have a sample for testing this feature ?

Right now - no. I have something that works, but it can't be used as sample "as is". It requires some time to make a sample from that. You think it's necessary?

[gabrielbull]

We need to add unit tests to new features if we want to achieve a decent test coverage some day.

Here is an example of a unit test I made for the Image Wrapping feature.

https://github.com/PHPOffice/PHPWord/blob/master/test/PHPWord/Tests/ImageTest.php

OK, guys. We'll see what I can do.

Any guides, wishes, and recommendations on the tests are welcome.

[Progi1984]

@RomanSyroeshko The sample is necessary. It permits to test your code easily before integration.

@gavroche Yes tests code are in the pipe for the next version (0.7.1) : #43

Guys, I'm stuck.

AFAIK, samples are just samples. Samples live in "samples" folder, provide users with "how to" and they are not somehow connected with unit tests. On the other hand, unit tests is a different thing. Unit tests live in "test" folder.

Do you want me to add something to the "samples" or to the "test" folder?

[gabrielbull]

@Progi1984 will have the last call on this but if I can had my 2 cents:

Every feature that is added needs to have a unit test with it. The samples should not exist and be replaced by a good documentation. In the last feature I added, I added the documentation directly to the README.md. This is O.K. for small projects but as we make more documentation, we will need to move some documentation elsewhere. A good practice will always be to include a getting started and examples to the README.md because it increases the number of people using the library.

So to answer your question, I guess you could make a unit test and than add a little HOWTO in the README.md for using your feature.

But wait for an answer by @Progi1984 .

[Progi1984]

I'm ok with @gavroche.

In Utopia, a good documentation would replace samples.
Personnally, i see like that :

• a good documentation (in markdown in the directory docs)
• some samples ( a good sample explain a feature )
• units tests with PHPUnit

[gabrielbull]

Why atoum and not PHPUnit? That would imply that developers have to learn a new Unit Test framework instead of using one that they already know.

[Progi1984]

Oops... @gavroche, it's an error of my side, I discussed about atoum and unit tests with my wife while I writed my answer... It's not atoum for this project, but PHPUnit.

Guys, could you please clarify why unit tests are organized in the way they are orginized now?

I would like to suggest using an approach when "test" directory mirrors "Classes" directory (see here for details). On my mind such organization looks more clear.

What do you think?

[Progi1984]

@RomanSyroeshko I wait for @brunocasado (#22) before releasing PHPWord 0.7.0. In the next release (0.7.1), one of my goal is to implement unit tests in all the project (#43). So, at this moment, I will check an eye on all the code and the organization of the code.

Okay, I will wait for 0.7.1 too then. It will be better to write unit tests once for correct organization of code than rewrite them several times.