Update README with project disclaimer, fix tests (#1)

scrummer · web-flow · commit 87984c5e50df · 2025-12-05T14:10:03.000+01:00
diff --git a/.github/ci/scripts/setup-opendxp-environment.sh b/.github/ci/scripts/setup-opendxp-environment.sh
@@ -4,3 +4,8 @@ set -eu -o xtrace
 
 #cp -rv .github/ci/files/var .
 cp .github/ci/files/.env .
+
+# Setup composer auth
+if [ -n "$COMPOSER_AUTH" ]; then
+composer config repositories.opendxp '{"type": "composer", "url": "https://open-dxp.repo.repman.io"}' --file composer.json
+fi
diff --git a/.gitignore b/.gitignore
@@ -14,12 +14,6 @@ Thumbs.db
 /app/config/local/*
 !app/config/local/.gitkeep
 
-# pimcore legacy (remove this for your own development)
-!/legacy
-/legacy/*
-!legacy/.gitkeep
-!legacy/bundle
-
 /var/*
 !/var/.gitkeep
 !/var/classes/
@@ -38,8 +32,7 @@ Thumbs.db
 /web/var/
 
 # PHP-CS-Fixer
-/.php_cs
-/.php_cs.cache
+/.php-cs-fixer.cache
 
 # composer
 /composer.lock
diff --git a/.php-cs-fixer.cache b/.php-cs-fixer.cache
diff --git a/.php_cs.dist b/.php_cs.dist
diff --git a/README.md b/README.md
@@ -1,12 +1,21 @@
----
-title: Advanced Object Search
----
-
 # OpenDXP Advanced Object Search via OpenSearch or Elasticsearch
 
 Advanced Object Search bundle provides advanced object search in 
 OpenDXP backend powered by search index technology (OpenSearch or Elasticsearch). 
 
+***
+
+## Disclaimer
+
+> OpenDXP is a community-driven fork based on the Pimcore® Community Edition (GPLv3).  
+> OpenDXP is independent and maintained by its community and contributors.
+> It is not affiliated with, endorsed by, or sponsored by Pimcore GmbH.   
+> Original credits: [Pimcore GmbH](https://www.pimcore.com)
+
+**OpenDXP Admin Bundle is based on the Pimcore® Community Edition and remains licensed under GPLv3.**
+
+***
+
 ## Integration into OpenDXP
 
 ### Installation and Configuration
@@ -232,3 +241,32 @@ opendxp_advanced_object_search:
 
 If you want custom filters in the result tab directly without having to create a new advanced object search every time
 read [here on how to extend the result tab with custom filters](./doc/01_Extending_Filters.md).
+
+***
+
+## Upstream Origin & Version Transparency
+This project is a fork of the [Pimcore advanced-object-search (5ffde33 / v6.1.1)](https://github.com/pimcore/advanced-object-search/tree/5ffde330f2963b6643b73fd31edc04511502c8b0), which is © Pimcore GmbH and licensed under GPLv3.
+
+## License
+Licensed under the GNU General Public License v3.0 (GPLv3). For details, please see [LICENSE.md](LICENSE.md).
+
+## Copyright
+© Pimcore GmbH  
+© 2025 OpenDXP Contributors — GPLv3
+
+## Trademarks
+Pimcore® is a registered [trademark](https://www.trademarkelite.com/europe/trademark/trademark-detail/009309841/PIMCORE) of Pimcore GmbH.
+Any use of the Pimcore® mark in this repository is purely descriptive to identify the original upstream project.
+
+***
+
+## Contact
+For inquiries, suggestions, or contributions, feel free to reach us at contact@opendxp.ch.
+
+## About
+OpenDXP is a community-driven project initiated by [DACHCOM.DIGITAL](https://www.dachcom.com/de-ch) (Rheineck, Switzerland) and maintained by its community and contributors.
+OpenDXP is independent and not affiliated with Pimcore GmbH.
+
+The project’s purpose is to preserve and maintain a GPLv3‑licensed codebase for community use.
+
+It is **not positioned as a competitor** to products or services of Pimcore GmbH and does **not** purport to replace or supersede any Pimcore offering.   
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -10,10 +10,10 @@ parameters:
 			message: "#^Instantiated class OpenDxp\\\\Bundle\\\\SimpleBackendSearchBundle\\\\OpenDxpSimpleBackendSearchBundle not found.$#"
 			reportUnmatched: false
 			count: 1
-			path: src/AdvancedObjectSearchBundle.php
+			path: src/OpenDxpAdvancedObjectSearchBundle.php
 
 		-
 			message: "#^Class OpenDxp\\\\Bundle\\\\SimpleBackendSearchBundle\\\\OpenDxpSimpleBackendSearchBundle not found.$#"
 			reportUnmatched: false
 			count: 1
-			path: src/AdvancedObjectSearchBundle.php
+			path: src/OpenDxpAdvancedObjectSearchBundle.php
diff --git a/phpstan.neon b/phpstan.neon
@@ -8,6 +8,7 @@ parameters:
     excludePaths:
         - src/Migrations/*
         - src/Tests/*
+    treatPhpDocTypesAsCertain: false
 
 includes:
-    - phpstan-baseline.neon
+    - phpstan-baseline.neon
diff --git a/src/Filter/FieldDefinitionAdapter/Fieldcollections.php b/src/Filter/FieldDefinitionAdapter/Fieldcollections.php
@@ -159,7 +159,7 @@ public function getIndexData($object)
 
             foreach ($fieldCollectionItems->getItems() as $item) {
                 /**
-                 * @var \Pimcore\Model\DataObject\Concrete $item
+                 * @var \OpenDxp\Model\DataObject\Concrete $item
                  */
                 $definition = Fieldcollection\Definition::getByKey($item->getType());
 
diff --git a/src/Filter/FieldDefinitionAdapter/ManyToOneRelation.php b/src/Filter/FieldDefinitionAdapter/ManyToOneRelation.php
@@ -27,7 +27,7 @@
 use OpenDxp\Normalizer\NormalizerInterface;
 
 /**
- * @property \Pimcore\Model\DataObject\ClassDefinition\Data\ManyToOneRelation $fieldDefinition
+ * @property \OpenDxp\Model\DataObject\ClassDefinition\Data\ManyToOneRelation $fieldDefinition
  */
 class ManyToOneRelation extends DefaultAdapter implements FieldDefinitionAdapterInterface
 {
diff --git a/src/Filter/FieldDefinitionAdapter/QuantityValue.php b/src/Filter/FieldDefinitionAdapter/QuantityValue.php
@@ -25,7 +25,7 @@
 use OpenDxp\Model\DataObject\Concrete;
 
 /**
- * @property \Pimcore\Model\DataObject\ClassDefinition\Data\QuantityValue $fieldDefinition
+ * @property \OpenDxp\Model\DataObject\ClassDefinition\Data\QuantityValue $fieldDefinition
  */
 class QuantityValue extends Numeric implements FieldDefinitionAdapterInterface
 {
diff --git a/src/Filter/FieldDefinitionAdapter/Select.php b/src/Filter/FieldDefinitionAdapter/Select.php
@@ -24,7 +24,7 @@
 use OpenDxp\Model\DataObject\Concrete;
 
 /**
- * @property \Pimcore\Model\DataObject\ClassDefinition\Data\Select $fieldDefinition
+ * @property \OpenDxp\Model\DataObject\ClassDefinition\Data\Select $fieldDefinition
  */
 class Select extends DefaultAdapter implements FieldDefinitionAdapterInterface
 {
diff --git a/src/Installer.php b/src/Installer.php
@@ -50,7 +50,7 @@ protected function installPermissions(): void
     public function install(): void
     {
         /**
-         * The simple backend search can be deactivated from Pimcore 11 on. But it is necessary for the advanced object search,
+         * The simple backend search can be deactivated in OpenDxp. But it is necessary for the advanced object search,
          * so we have to make sure that it is activated & installed.
          */
         $simpleBackendSearchInstaller = \OpenDxp::getContainer()->get(\OpenDxp\Bundle\SimpleBackendSearchBundle\Installer::class);
diff --git a/src/Resources/public/js/events.js b/src/Resources/public/js/events.js
@@ -17,12 +17,12 @@
  */
 opendxp.events.onAdvancedObjectSearchResult = "opendxp.advancedObjectSearch.result.initialize";
 
-//TODO: delete once support for Pimcore 10.6 is dropped
+//TODO: delete once support for OpenDxp 1 is dropped
 
 if(typeof addEventListenerCompatibilityForPlugins === "function") {
     let eventMappings = [];
     eventMappings["onAdvancedObjectSearchResult"] = opendxp.events.onAdvancedObjectSearchResult;
     addEventListenerCompatibilityForPlugins(eventMappings);
-    console.warn("Deprecation: addEventListenerCompatibilityForPlugins will be not supported in OpenDxp 11.");
+    console.warn("Deprecation: addEventListenerCompatibilityForPlugins will be not supported in OpenDxp 2.");
 
 }
diff --git a/src/Resources/public/js/searchConfig/resultExtension.js b/src/Resources/public/js/searchConfig/resultExtension.js
@@ -100,7 +100,7 @@ opendxp.bundle.advancedObjectSearch.searchConfig.ResultPanelExtensionBag = Class
             for (var i = 0; i < columns.length; i++) {
                 var column = columns[i];
 
-                //TODO remove childs, when drop pimcore X support
+                //TODO remove childs, when drop opendxp 1 support
                 if (column.isOperator && this._hasFieldRecursive(fieldname, column.attributes.childs ?? column.attributes.children)) {
                     return true
                 } else if (column.attribute == fieldname || column.key == fieldname) {
@@ -128,7 +128,7 @@ opendxp.bundle.advancedObjectSearch.searchConfig.ResultPanelExtensionBag = Class
                 }
 
                 if (column.isOperator) {
-                    //TODO remove childs, when drop pimcore X support
+                    //TODO remove childs, when drop opendxp 1 support
                     this._hasOperatorRecursive(config, column.attributes.childs ?? column.attributes.children);
                 }
             }
diff --git a/src/Service.php b/src/Service.php
@@ -803,7 +803,7 @@ protected function addPermissionsExcludeFilter(Search $search)
             throw new Exception('User not allowed to search for objects');
         } else {
             $forbiddenObjectPaths = \OpenDxp\Model\Element\Service::findForbiddenPaths('object', $this->user);
-            if (isset($forbiddenObjectPaths['forbidden'])) {   // @phpstan-ignore-line
+            if (isset($forbiddenObjectPaths['forbidden'])) {
                 $forbiddenObjectPaths = array_keys($forbiddenObjectPaths['forbidden']);
             }
             if (count($forbiddenObjectPaths) > 0) {

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`use OpenDxp\Normalizer\NormalizerInterface;`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * @property \Pimcore\Model\DataObject\ClassDefinition\Data\ManyToOneRelation $fieldDefinition`
	`30`	`+ * @property \OpenDxp\Model\DataObject\ClassDefinition\Data\ManyToOneRelation $fieldDefinition`
`31`	`31`	`*/`
`32`	`32`	`class ManyToOneRelation extends DefaultAdapter implements FieldDefinitionAdapterInterface`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`use OpenDxp\Model\DataObject\Concrete;`
`26`	`26`
`27`	`27`	`/**`
`28`		`- * @property \Pimcore\Model\DataObject\ClassDefinition\Data\QuantityValue $fieldDefinition`
	`28`	`+ * @property \OpenDxp\Model\DataObject\ClassDefinition\Data\QuantityValue $fieldDefinition`
`29`	`29`	`*/`
`30`	`30`	`class QuantityValue extends Numeric implements FieldDefinitionAdapterInterface`
`31`	`31`	`{`