Skip to content

Samshal/xsl

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

xsl

XSL 2.0 Transpiler in PHP

Installation

Requires PHP 5.6 or later. There are no plans to support PHP 5.5 or earlier. PRs in this matter are rejected. It is installable and autoloadable via Composer as genkgo/xsl.

Quality

Scrutinizer Code Quality Code Coverage Build Status

To run the unit tests at the command line, issue phpunit -c tests/. PHPUnit is required.

This library attempts to comply with PSR-1, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request.

Getting Started

Replace XSLTProcessor with Genkgo\Xsl\XsltProcessor, change version="1.0" in version="2.0" and you are done!

<?php
use Genkgo\Xsl\XsltProcessor;

$xslDoc = new DOMDocument();
$xslDoc->load('Stubs/collection.xsl');

$xmlDoc = new DOMDocument();
$xmlDoc->load('Stubs/collection.xml');

$transpiler = new XsltProcessor();
$transpiler->importStylesheet($xslDoc);
echo $transpiler->transformToXML($xmlDoc);

Create your own extenions

You can also register your own extensions. Just implement the XmlNamespaceInterface and you are ready to use your own element transformations and xpath functions. See the example below and the integration test to understand how it works.

<?php
// use omitted for readability

class MyExtensions implements XmlNamespaceInterface {

    const URI = 'https://github.com/genkgo/xsl/tree/master/tests/Stubs/Extension/MyExtension';

    public function register(TransformerCollection $transformers, FunctionMap $functions) {
        $functions->set('helloWorld', new StringFunction('helloWorld', static::class), self::URI);
    }

    public static function helloWorld(...$args) {
        return 'Hello World was called and received ' . count($args) . ' arguments!';
    }

}

$config = new Config();
$config->setExtensions(new MyExtensions());

$processor = new XsltProcessor($config);

and then call the function in your style sheet.

<xsl:stylesheet version="2.0"
        xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        xmlns:my="https://github.com/genkgo/xsl/tree/master/tests/Stubs/Extension/MyExtension">

    <xsl:output omit-xml-declaration="yes" />

    <xsl:template match="/">
        <xsl:value-of select="my:hello-world(1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)" />
    </xsl:template>

</xsl:stylesheet>

will yield: Hello World was called and received 20 arguments!.

Caching: transpile once

Depending on the complexity of your stylesheet, the transpiling process could slow down the processing of your document. Therefore, you probably want to cache the result stylesheet. By adding genkgo/cache to your composer.json, you will add the possibility to enable caching. See the example below, or the integration test to see how it works.

<?php
use Genkgo\Cache\Adapters\ArrayAdapter;
use Genkgo\Cache\Adapters\SimpleCallbackAdapter;
use Genkgo\Xsl\Config;
use Genkgo\Xsl\XsltProcessor;

$arrayCache = new ArrayAdapter();

$config = new Config();
$config->setCacheAdapter(new SimpleCallbackAdapter($arrayCache));

$transpiler = new XsltProcessor($config);

Contributing

  • Found a bug? Please try to solve it yourself first and issue a pull request. If you are not able to fix it, at least give a clear description what goes wrong. We will have a look when there is time.
  • Want to see a feature added, issue a pull request and see what happens. You could also file a bug of the missing feature and we can discuss how to implement it.

About

XSL 2.0 Transpiler in PHP

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 83.5%
  • XSLT 16.5%