Add options for fileExtension and XSD validation in XML mapping (#126)

Author: haltuf

.docs/README.md

@@ -93,6 +93,9 @@ nettrine.orm:
           type: <attributes|xml>
           directories: <string[]>
           namespace: <string>
+          options:
+            fileExtension: <string>
+            xsdValidation: <boolean>
 
       defaultCache: <class-string|service>
       queryCache: <class-string|service>
@@ -371,8 +374,13 @@ nettrine.orm:
           type: xml
           directories: [%appDir%/Database]
           namespace: App\Database
+          options:
+            fileExtension: .orm.xml
+            xsdValidation: true
 ```
 
+Setting `xsdValidation` to `false` will allow using custom XML elements in mapping files, as used by some behavior extensions (e.g. gedmo:sortable-position).
+
 ### Helper
 
 You can use `MappingHelper` to add multiple mappings at once. This is useful when you have multiple modules with entities.

src/DI/OrmExtension.php

@@ -21,28 +21,28 @@
 /**
  * @property-read stdClass $config
  * @phpstan-type TManagerConfig object{
- *     entityManagerDecoratorClass: string,
+ *     entityManagerDecoratorClass: string|null,
  *     configurationClass: string,
  *     lazyNativeObjects: bool|null,
  *     proxyDir: string|null,
  *     autoGenerateProxyClasses: int|bool|Statement,
  *     proxyNamespace: string|null,
- *     metadataDriverImpl: string,
+ *     metadataDriverImpl: string|null,
  *     entityNamespaces: array<string, string>,
  *     resolveTargetEntities: array<string, string>,
  *     customStringFunctions: array<string, string>,
  *     customNumericFunctions: array<string, string>,
  *     customDatetimeFunctions: array<string, string>,
  *     customHydrationModes: array<string, string>,
- *     classMetadataFactoryName: string,
- *     defaultRepositoryClassName: string,
+ *     classMetadataFactoryName: string|null,
+ *     defaultRepositoryClassName: string|null,
  *     namingStrategy: string|Statement|null,
  *     quoteStrategy: string|Statement|null,
  *     entityListenerResolver: string|Statement|null,
  *     repositoryFactory: string|Statement|null,
  *     defaultQueryHints: array<string, mixed>,
  *     filters: array<string, object{class: string, enabled: bool}>,
- *     mapping: array<string, object{type: 'attributes'|'xml', directories: string[], namespace: string}>,
+ *     mapping: array<string, object{type: 'attributes'|'xml', directories: string[], namespace: string, options: object{fileExtension: string, xsdValidation: bool}}>,
  *     defaultCache: string|Statement|null,
  *     queryCache: string|Statement|null,
  *     resultCache: string|Statement|null,
@@ -128,6 +128,10 @@ public function getConfigSchema(): Schema
 							'type' => Expect::anyOf('attributes', 'xml')->default('attributes'),
 							'directories' => Expect::listOf(Expect::string())->min(1)->required(),
 							'namespace' => Expect::string()->required(),
+							'options' => Expect::structure([
+								'fileExtension' => Expect::string()->default('.orm.xml'),
+								'xsdValidation' => Expect::bool()->default(true),
+							]),
 						]),
 						Expect::string()
 					)->default([]),

src/DI/Pass/ManagerPass.php

@@ -277,7 +277,7 @@ public function loadManagerConfiguration(string $managerName, mixed $managerConf
 				]);
 			} elseif ($mapping->type === 'xml') {
 				$mappingDriver->addSetup('addDriver', [
-					new Statement(SimplifiedXmlDriver::class, [array_combine($mapping->directories, array_fill(0, count($mapping->directories), $mapping->namespace))]),
+					new Statement(SimplifiedXmlDriver::class, [array_combine($mapping->directories, array_fill(0, count($mapping->directories), $mapping->namespace)), $mapping->options->fileExtension, $mapping->options->xsdValidation]),
 					$mapping->namespace,
 				]);
 			} else {

tests/Cases/DI/OrmExtension.mapping.phpt

@@ -92,6 +92,9 @@ Toolkit::test(function (): void {
 									type: xml
 									directories: [%fixturesDir%/Entity, %fixturesDir%/../Toolkit]
 									namespace: Tests\Mocks\Dummy
+									options:
+										fileExtension: .custom.xml
+										xsdValidation: false
 				NEON
 			));
 		})
@@ -107,6 +110,10 @@ Toolkit::test(function (): void {
 	Assert::type(SimplifiedXmlDriver::class, $xmlDriver);
 	Assert::equal([], $xmlDriver->getAllClassNames());
 	Assert::count(2, $xmlDriver->getLocator()->getPaths());
+	Assert::equal('.custom.xml', $xmlDriver->getLocator()->getFileExtension());
+
+	$r = (new ReflectionClass($xmlDriver))->getParentClass();
+	Assert::false($r->getProperty('isXsdValidationEnabled')->getValue($xmlDriver));
 });
 
 // Driver: all

tests/Cases/DI/OrmExtension.proxy.phpt

@@ -141,10 +141,11 @@ Toolkit::test(function (): void {
 	// Skip on PHP < 8.4 OR doctrine/orm < v3.4.0
 	if (PHP_VERSION_ID < 80400 || !method_exists(Configuration::class, 'enableNativeLazyObjects')) {
 		Assert::true(true);
+
 		return;
 	}
 
-	$builder = ContainerBuilder::of()
+	$container = ContainerBuilder::of()
 		->withCompiler(function (Compiler $compiler): void {
 			$compiler->addExtension('nettrine.dbal', new DbalExtension());
 			$compiler->addExtension('nettrine.orm', new OrmExtension());