Version 2.2.0

- Refactor namespace `\CfdiUtils\CadenaOrigen` (backwards compatible): 
    - Instead of one only xslt builder now it includes: 
        - `DOMBuilder`: Uses the regular PHP based method 
        - `GenkgoXslBuilder`: Uses the library genkgo/xsl xslt version 2 library 
        - `SaxonbCliBuilder`: Uses the command line saxonb-xslt command 
    - Build process implementations must return `XsltBuildException` (before they return `RuntimeException`) 
    - All builders must implement `XsltBuilderInterface` 
    - Add `XsltBuilderPropertyInterface` and `XsltBuilderPropertyTrait`. 
      It does not have `hasXsltBuilderProperty`method. 
    - `DefaultLocations` has been deprecated in favor of `CfdiDefaultLocations` 
    - `CadenaOrigenBuilder` has been deprecated in favor of `DOMBuilder` 
    - `CadenaOrigenLocations` has been deprecated, will not be replaced 
- Implement `XsltBuilderPropertyInterface` and `XsltBuilderPropertyTrait` in objects that use 
  to create `CadenaOrigenBuilder` objects. 
- For `CfdiCreator33` and `CfdiValidator33` will create a default DOMBuilder object if none set. 
- Hydrator also receive and hydrates this by using `RequireXsltBuilderInterface`. 
- `CertificadoPropertyInterface` and `CertificadoPropertyTrait` has been created. 
- Improve the tests.

Author: eclipxe13

.travis.yml

@@ -10,6 +10,11 @@ php:
 # See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
 sudo: false
 
+addons:
+  apt:
+    packages:
+      - libsaxonb-java
+
 before_script:
   - travis_retry composer install --no-interaction --prefer-dist
   - |

README.md

@@ -38,6 +38,16 @@ composer require eclipxe/cfdiutils
 ```
 
 
+## Major versions
+
+- Version 1.x **deprecated** was deprecated time ago, that version didn't do much anyway
+- Version 2.x **current** has a lot of features and helper objects
+- Version 3.x **future** will be released with the following backward compatibility breaks:
+    - Rename `\CfdiUtils\CadenaOrigen\CadenaOrigenBuilder` to `\CfdiUtils\CadenaOrigen\DOMBuilder`
+    - Rename `\CfdiUtils\CadenaOrigen\DefaultLocations` to `\CfdiUtils\CadenaOrigen\CfdiDefaultLocations`
+    - Remove `\CfdiUtils\CadenaOrigen\CadenaOrigenLocations`
+
+
 ## PHP Support
 
 This library is compatible with PHP versions 7.0 and above.

composer.json

@@ -20,7 +20,11 @@
         "eclipxe/xmlresourceretriever": "^1.2",
         "eclipxe/xmlschemavalidator": "^2.0"
     },
+    "suggest": {
+        "genkgo/xsl": "^0.5.20"
+    },
     "require-dev": {
+        "genkgo/xsl": "^0.5.20",
         "phpunit/phpunit": "^6.2",
         "jakub-onderka/php-parallel-lint": "^0.9",
         "squizlabs/php_codesniffer": "^3.0",

docs/CHANGELOG.md

@@ -1,3 +1,24 @@
+# Version 2.2.0 2018-01-24
+- Refactor namespace `\CfdiUtils\CadenaOrigen` (backwards compatible):
+    - Instead of one only xslt builder now it includes:
+        - `DOMBuilder`: Uses the regular PHP based method
+        - `GenkgoXslBuilder`: Uses the library genkgo/xsl xslt version 2 library
+        - `SaxonbCliBuilder`: Uses the command line saxonb-xslt command
+    - Build process implementations must return `XsltBuildException` (before they return `RuntimeException`)
+    - All builders must implement `XsltBuilderInterface`
+    - Add `XsltBuilderPropertyInterface` and `XsltBuilderPropertyTrait`.
+      It does not have `hasXsltBuilderProperty`method.
+    - `DefaultLocations` has been deprecated in favor of `CfdiDefaultLocations`
+    - `CadenaOrigenBuilder` has been deprecated in favor of `DOMBuilder`
+    - `CadenaOrigenLocations` has been deprecated, will not be replaced
+- Implement `XsltBuilderPropertyInterface` and `XsltBuilderPropertyTrait` in objects that use
+  to create `CadenaOrigenBuilder` objects.
+- For `CfdiCreator33` and `CfdiValidator33` will create a default DOMBuilder object if none set.
+- Hydrator also receive and hydrates this by using `RequireXsltBuilderInterface`.
+- `CertificadoPropertyInterface` and `CertificadoPropertyTrait` has been created.
+- Improve the tests.
+
+
 # Version 2.1.0 2018-01-17
 - Fix `SumasConceptos` to work also with "ImpuestosLocales"
 - Add elements helpers `CfdiUtils\Elements\ImpLocal10\ImpuestosLocales` to work with "ImpuestosLocales"

src/CfdiUtils/CadenaOrigen/AbstractXsltBuilder.php

@@ -0,0 +1,16 @@
+<?php
+namespace CfdiUtils\CadenaOrigen;
+
+abstract class AbstractXsltBuilder implements XsltBuilderInterface
+{
+    protected function assertBuildArguments(string $xmlContent, string $xsltLocation): string
+    {
+        if ('' === $xmlContent) {
+            throw new \UnexpectedValueException('The XML content to transform is empty');
+        }
+        if ('' === $xsltLocation) {
+            throw new \UnexpectedValueException('Xslt location was not set');
+        }
+        return '';
+    }
+}

src/CfdiUtils/CadenaOrigen/CadenaOrigenBuilder.php

@@ -1,77 +1,11 @@
 <?php
 namespace CfdiUtils\CadenaOrigen;
 
-use DOMDocument;
-use LibXMLError;
-use XSLTProcessor;
-
 /**
- * The class CadenaOrigenLocations create the CadenaOrigenLocations by transforming the XML contents
- * using the XSLT utilities provided by SAT.
- *
- * This class is a helps override or set the location of the clst resource.
+ * Use some implementation of XsltBuilderInterface
+ * @see DOMBuilder
+ * @deprecated Will be removed in release 3.0
  */
-class CadenaOrigenBuilder
+class CadenaOrigenBuilder extends DOMBuilder
 {
-    /**
-     * Perform the xslt transformation if the xml contents to create the "Cadena de origen"
-     * for a "Comprobante fiscal digital por internet (cfdi)"
-     *
-     * This method will search for the registered xslt location the xlstLocation argument is empty
-     *
-     * All errors generated by the process will create a RuntimeException
-     *
-     * @param string $cfdiContent
-     * @param string $xsltLocation
-     * @return string
-     * @throws \UnexpectedValueException if the cfdi content is empty
-     * @throws \RuntimeException on procedural errors
-     */
-    public function build(string $cfdiContent, string $xsltLocation): string
-    {
-        if ('' === $cfdiContent) {
-            throw new \UnexpectedValueException('The XML content to transform is empty');
-        }
-        if ('' === $xsltLocation) {
-            throw new \UnexpectedValueException('Xslt location was not set');
-        }
-        $libxmlErrors = libxml_use_internal_errors(true);
-        try {
-            // load the cfdi document
-            $cfdi = new DOMDocument();
-            if (! $cfdi->loadXML($cfdiContent)) {
-                throw $this->createLibXmlErrorOrMessage('Error while loading the cfdi content');
-            }
-
-            $xsl = new DOMDocument();
-            if (! $xsl->load($xsltLocation)) {
-                throw $this->createLibXmlErrorOrMessage('Error while loading the Xslt location');
-            }
-
-            $xslt = new XSLTProcessor();
-            if (! $xslt->importStylesheet($xsl)) {
-                throw $this->createLibXmlErrorOrMessage('Error while importing the style sheet from the Xslt location');
-            }
-
-            // this error silenced call is intentional, avoid transformation errors except when return false
-            $transform = @$xslt->transformToXml($cfdi);
-            if (false === $transform || null === $transform) {
-                throw $this->createLibXmlErrorOrMessage('Error while transforming the xslt content');
-            }
-
-            return $transform;
-        } finally {
-            libxml_clear_errors();
-            libxml_use_internal_errors($libxmlErrors);
-        }
-    }
-
-    private function createLibXmlErrorOrMessage(string $message): \RuntimeException
-    {
-        $error = libxml_get_last_error();
-        if (($error instanceof LibXMLError) && isset($error->message)) {
-            $message = $message . ': ' . $error->message;
-        }
-        return new \RuntimeException($message);
-    }
 }

src/CfdiUtils/CadenaOrigen/CadenaOrigenLocations.php

@@ -7,21 +7,23 @@
  * The class CadenaOrigenLocations create the CadenaOrigenLocations by transforming the XML contents
  * using the XSLT utilities provided by SAT.
  *
- * This class is a helps override or set the location of the clst resource.
+ * This class is a helps override or set the location of the xslt resource.
+ *
+ * @deprecated Will be removed in release 3.0
  */
 class CadenaOrigenLocations
 {
     /**
-     * Private array containing urls for xlst versions
+     * Private array containing urls for xslt versions
      * @var string[]
      */
     private $xsltLocations = [
-        '3.2' => DefaultLocations::XSLT_32,
-        '3.3' => DefaultLocations::XSLT_33,
+        '3.2' => CfdiDefaultLocations::XSLT_32,
+        '3.3' => CfdiDefaultLocations::XSLT_33,
     ];
 
     /**
-     * Return the registered location of the xlst file to perform the xml transformation
+     * Return the registered location of the xslt file to perform the xml transformation
      * depending on the cfdi version. This value can be changed using setXsltLocation
      *
      * @see setXsltLocation
@@ -37,7 +39,7 @@ public function getXsltLocation(string $version): string
     }
 
     /**
-     * Override the default location of the xlst for an specified version
+     * Override the default location of the xslt for an specified version
      *
      * @param string $version
      * @param string $location
@@ -71,7 +73,7 @@ public function getXsltLocationFromXml(string $cfdiContent): string
      * Perform the xslt transformation if the xml contents to create the "Cadena de origen"
      * for a "Comprobante fiscal digital por internet (cfdi)"
      *
-     * This method will search for the registered xslt location the xlstLocation argument is empty
+     * This method will search for the registered xslt location the xsltLocation argument is empty
      *
      * All errors generated by the process will create a RuntimeException
      *
@@ -83,7 +85,7 @@ public function getXsltLocationFromXml(string $cfdiContent): string
     public function build(string $cfdiContent): string
     {
         $xsltLocation = $this->getXsltLocationFromXml($cfdiContent);
-        $builder = new CadenaOrigenBuilder();
+        $builder = new DOMBuilder();
         return $builder->build($cfdiContent, $xsltLocation);
     }
 }

src/CfdiUtils/CadenaOrigen/CfdiDefaultLocations.php

@@ -0,0 +1,19 @@
+<?php
+namespace CfdiUtils\CadenaOrigen;
+
+class CfdiDefaultLocations
+{
+    const XSLT_32 = 'http://www.sat.gob.mx/sitio_internet/cfd/3/cadenaoriginal_3_2/cadenaoriginal_3_2.xslt';
+    const XSLT_33 = 'http://www.sat.gob.mx/sitio_internet/cfd/3/cadenaoriginal_3_3/cadenaoriginal_3_3.xslt';
+
+    public static function location(string $version): string
+    {
+        if ('3.3' === $version) {
+            return static::XSLT_33;
+        }
+        if ('3.2' === $version) {
+            return static::XSLT_32;
+        }
+        throw new \UnexpectedValueException("Cannot get the default xslt location for version '$version'");
+    }
+}

src/CfdiUtils/CadenaOrigen/DOMBuilder.php

@@ -0,0 +1,58 @@
+<?php
+namespace CfdiUtils\CadenaOrigen;
+
+use DOMDocument;
+use LibXMLError;
+use XSLTProcessor;
+
+class DOMBuilder extends AbstractXsltBuilder
+{
+    public function build(string $xmlContent, string $xsltLocation): string
+    {
+        $this->assertBuildArguments($xmlContent, $xsltLocation);
+        $libxmlErrors = libxml_use_internal_errors(true);
+        try {
+            // load the xml document
+            $xml = new DOMDocument();
+            if (! $xml->loadXML($xmlContent)) {
+                throw $this->createLibXmlErrorOrMessage('Error while loading the xml content');
+            }
+
+            $xsl = new DOMDocument();
+            if (! $xsl->load($xsltLocation)) {
+                throw $this->createLibXmlErrorOrMessage('Error while loading the Xslt location');
+            }
+
+            return $this->transform($xml, $xsl);
+        } finally {
+            libxml_clear_errors();
+            libxml_use_internal_errors($libxmlErrors);
+        }
+    }
+
+    protected function transform(DOMDocument $xml, DOMDocument $xsl): string
+    {
+        $xslt = new XSLTProcessor();
+        if (! $xslt->importStylesheet($xsl)) {
+            throw $this->createLibXmlErrorOrMessage('Error while importing the style sheet from the Xslt location');
+        }
+
+        // this error silenced call is intentional, avoid transformation errors except when return false
+        /** @var string|null|false $transform */
+        $transform = @$xslt->transformToXml($xml);
+        if (null === $transform || false === $transform) {
+            throw $this->createLibXmlErrorOrMessage('Error while transforming the xslt content');
+        }
+
+        return $transform;
+    }
+
+    protected function createLibXmlErrorOrMessage(string $message): XsltBuildException
+    {
+        $error = libxml_get_last_error();
+        if (($error instanceof LibXMLError) && isset($error->message)) {
+            $message = $message . ': ' . $error->message;
+        }
+        return new XsltBuildException($message);
+    }
+}

src/CfdiUtils/CadenaOrigen/DefaultLocations.php

@@ -1,19 +1,10 @@
 <?php
 namespace CfdiUtils\CadenaOrigen;
 
-class DefaultLocations
+/**
+ * @deprecated Will be removed in release 3.0
+ * @see CfdiDefaultLocations
+ */
+class DefaultLocations extends CfdiDefaultLocations
 {
-    const XSLT_32 = 'http://www.sat.gob.mx/sitio_internet/cfd/3/cadenaoriginal_3_2/cadenaoriginal_3_2.xslt';
-    const XSLT_33 = 'http://www.sat.gob.mx/sitio_internet/cfd/3/cadenaoriginal_3_3/cadenaoriginal_3_3.xslt';
-
-    public static function location(string $version): string
-    {
-        if ('3.3' === $version) {
-            return static::XSLT_33;
-        }
-        if ('3.2' === $version) {
-            return static::XSLT_32;
-        }
-        throw new \UnexpectedValueException("Cannot get the default xslt location for version '$version'");
-    }
 }

src/CfdiUtils/CadenaOrigen/GenkgoXslBuilder.php

@@ -0,0 +1,30 @@
+<?php
+namespace CfdiUtils\CadenaOrigen;
+
+use DOMDocument;
+use Genkgo\Xsl\XsltProcessor;
+
+class GenkgoXslBuilder extends DOMBuilder
+{
+    public function __construct()
+    {
+        if (! class_exists(XsltProcessor::class)) {
+            throw new \RuntimeException('To use GenkgoXslBuilder you must install genkgo/xsl');
+        }
+    }
+
+    protected function transform(DOMDocument $xml, DOMDocument $xsl): string
+    {
+        $xslt = new XSLTProcessor();
+        $xslt->importStyleSheet($xsl);
+
+        // this error silenced call is intentional, avoid transformation errors except when return false
+        /** @var string|null|false $transform */
+        $transform = @$xslt->transformToXML($xml);
+        if (null === $transform || false === $transform) {
+            throw $this->createLibXmlErrorOrMessage('Error while transforming the xslt content');
+        }
+
+        return $transform;
+    }
+}