back to basics

Author: Jaco Labuschagne

.gitignore

@@ -2,4 +2,7 @@
 .phpunit.result.cache
 .php-cs-fixer.cache
 /.phpunit.cache/
-composer.lock
+composer.lock
+node_modules
+xprofiling
+package-lock.json

.php-cs-fixer.php

@@ -25,6 +25,11 @@
         'strict_param' => true,
         'declare_strict_types' => true,
         'phpdoc_to_comment' => false,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
     ])
     ->setFinder($finder)
 ;

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "zodimo/xml",
-  "description": "Basic types that communicates the possibility of failure and optional values.",
+  "description": "php xml parsers",
   "type": "library",
   "license": "mit",
   "autoload": {
@@ -21,15 +21,21 @@
   ],
   "require": {
     "php": "~7.4|~8",
-    "zodimo/base-return":"^0"
+    "zodimo/base-return": "^0",
+    "webmozart/assert": "^1.11"
   },
   "require-dev": {
     "phpunit/phpunit": "^9.6",
     "phpstan/phpstan": "^1.11",
     "friendsofphp/php-cs-fixer": "^3.62",
-    "zodimo/base-return-test": "^0"
+    "zodimo/base-return-test": "^0",
+    "phpbench/phpbench": "^1.2"
   },
   "scripts": {
+    "bench": [
+      "Composer\\Config::disableProcessTimeout",
+      "php ./vendor/bin/phpbench run tests/Benchmark/"
+    ],
     "test": [
       "Composer\\Config::disableProcessTimeout",
       "php ./vendor/bin/phpunit"

managed_context/metadata.json

@@ -0,0 +1 @@
+{"current_schema_version":"0.0.1"}

phpbench.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "./vendor/phpbench/phpbench/phpbench.schema.json",
+  "runner.bootstrap": "vendor/autoload.php"
+}

phpstan.neon

@@ -2,6 +2,7 @@ parameters:
 	level: 8
 	paths:
 		- src
+	treatPhpDocTypesAsCertain: false
 
 
 

src/Errors/XmlParserException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zodimo\Xml\Errors;
+
+class XmlParserException extends \Exception implements \Throwable
+{
+    public static function create(string $message, int $code = 0, ?\Throwable $previous = null): XmlParserException
+    {
+        return new self($message, $code, $previous);
+    }
+}

src/Errors/XmlParsingException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zodimo\Xml\Errors;
+
+class XmlParsingException extends \Exception implements \Throwable
+{
+    public static function create(string $message, int $code = 0, ?\Throwable $previous = null): XmlParsingException
+    {
+        return new self($message, $code, $previous);
+    }
+}

src/RegisterListenerInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zodimo\Xml;
+
+use Zodimo\BaseReturn\IOMonad;
+use Zodimo\Xml\Errors\XmlParserException;
+
+interface RegisterListenerInterface
+{
+    /**
+     * @param callable(SimpleXmlReaderInterface):bool $callback
+     *
+     * @return IOMonad<XmlReaderParser,XmlParserException>
+     */
+    public function registerCallback(string $xpath, callable $callback, int $nodeType = \XMLReader::ELEMENT): IOMonad;
+}