Update for translation handling and support arbitrary routing

.composer-require-checker.json

@@ -1,6 +1,6 @@
 {
   "symbol-whitelist": [
-    "array", "bool", "false", "int", "mixed", "null", "self", "static", "parent", "string", "true", "void",
+    "array", "bool", "false", "int", "mixed", "never", "null", "self", "static", "parent", "string", "true", "void",
     "ContaoCommunityAlliance\\Contao\\EventDispatcher\\CcaEventDispatcherBundle",
     "ContaoCommunityAlliance\\DcGeneral\\Contao\\View\\Contao2BackendView\\Exception\\EditOnlyModeException",
     "ContaoCommunityAlliance\\DcGeneral\\Contao\\View\\Contao2BackendView\\Exception\\NotCreatableException",

.github/workflows/diagnostics.yml

@@ -19,7 +19,7 @@ jobs:
 
     steps:
       - name: Pull source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP with PECL extension
         uses: shivammathur/setup-php@v2
@@ -28,15 +28,15 @@ jobs:
 
       # setup caches
       - name: Cache composer cache directory
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: composer-cache-dir
         with:
           path: ~/.cache/composer
           key: ${{ runner.os }}-${{ matrix.php }}-build-${{ env.cache-name }}
 
       - name: Cache vendor directory
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: vendor
         with:
@@ -46,7 +46,7 @@ jobs:
             ${{ runner.os }}-${{ matrix.php }}-${{ matrix.contao }}-build-${{ env.cache-name }}-
 
       - name: Cache phpcq directory
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: phpcq
         with:
@@ -68,7 +68,7 @@ jobs:
         run: ./vendor/bin/phpcq run -v ${{ matrix.output }}
 
       - name: Upload build directory to artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: ${{ success() }} || ${{ failure() }}
         with:
           name: phpcq-builds-php-${{ matrix.php }}-${{ matrix.contao }}

composer.json

@@ -36,7 +36,7 @@
     "ext-json": "*",
     "ext-pdo": "*",
     "contao-community-alliance/events-contao-bindings": "^4.13",
-    "contao-community-alliance/translator": "^2.3",
+    "contao-community-alliance/translator": "^2.4.2",
     "contao-community-alliance/url-builder": "^1.3",
     "contao/core-bundle": "^4.13",
     "contao/image": "^1.1",
@@ -95,12 +95,8 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "2.3.x-dev",
-      "dev-support/2.1.x": "2.1.x-dev"
+      "dev-master": "2.4.x-dev"
     },
     "contao-manager-plugin": "ContaoCommunityAlliance\\DcGeneral\\ContaoManager\\Plugin"
-  },
-  "scripts": {
-    "php-cs-fixer": "php-cs-fixer fix --rules=@PSR2"
   }
 }

src/BaseConfigRegistry.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -13,7 +13,8 @@
  * @package    contao-community-alliance/dc-general
  * @author     Christian Schiffler <[email protected]>
  * @author     Sven Baumann <[email protected]>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @author     Ingolf Steinhardt <[email protected]>
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -121,7 +122,7 @@ private function addParentFilter(ModelIdInterface $idParent, ConfigInterface $co
                 $baseFilter = $config->getFilter();
                 $filter     = $condition->getFilter($parent);
 
-                if ($baseFilter) {
+                if (\is_array($baseFilter)) {
                     $filter = array_merge($baseFilter, $filter);
                 }
 
@@ -144,6 +145,7 @@ private function addParentFilter(ModelIdInterface $idParent, ConfigInterface $co
     private function buildBaseConfig(?ModelIdInterface $parentId): ConfigInterface
     {
         $environment = $this->getEnvironment();
+        assert($environment instanceof EnvironmentInterface);
         $provider    = $environment->getDataProvider();
         if (null === $provider) {
             throw new DcGeneralRuntimeException('Data provider not set.');
@@ -156,7 +158,7 @@ private function buildBaseConfig(?ModelIdInterface $parentId): ConfigInterface
         $additional = $definition->getBasicDefinition()->getAdditionalFilter();
 
         // Custom filter common for all modes.
-        if ($additional) {
+        if (\is_array($additional)) {
             $config->setFilter($additional);
         }
 

src/Clipboard/Clipboard.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -16,7 +16,8 @@
  * @author     David Molineus <[email protected]>
  * @author     Stefan Heimes <[email protected]>
  * @author     Sven Baumann <[email protected]>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @author     Ingolf Steinhardt <[email protected]>
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -129,8 +130,8 @@ public function remove(ItemInterface $item)
     public function removeById(ModelIdInterface $modelId)
     {
         $serializedId = $modelId->getSerialized();
-        if (!empty($this->itemsByModelId[$serializedId])) {
-            foreach ($this->itemsByModelId[$serializedId] as $item) {
+        if ([] !== ($items = $this->itemsByModelId[$serializedId] ?? [])) {
+            foreach ($items as $item) {
                 unset($this->items[$item->getClipboardId()]);
             }
 
@@ -176,7 +177,7 @@ public function has(ItemInterface $item)
      */
     public function hasId(ModelIdInterface $modelId)
     {
-        return !empty($this->itemsByModelId[$modelId->getSerialized()]);
+        return (bool) ($this->itemsByModelId[$modelId->getSerialized()] ?? false);
     }
 
     /**

src/Contao/Callback/AbstractCallbackListener.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2022 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -15,7 +15,7 @@
  * @author     Tristan Lins <[email protected]>
  * @author     Sven Baumann <[email protected]>
  * @author     Ingolf Steinhardt <[email protected]>
- * @copyright  2013-2022 Contao Community Alliance.
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -60,7 +60,7 @@ public function __construct($callback, $restrictions = null)
     {
         $this->callback = $callback;
 
-        if ($restrictions) {
+        if (\is_array($restrictions)) {
             call_user_func_array([$this, 'setRestrictions'], $restrictions);
         }
     }
@@ -86,7 +86,7 @@ public function setRestrictions(?string $dataContainerName = null)
      */
     public function wantToExecute($event)
     {
-        if (empty($this->dataContainerName)) {
+        if (null === $this->dataContainerName) {
             return true;
         }
         if (!$event instanceof EnvironmentAwareInterface) {
@@ -95,6 +95,7 @@ public function wantToExecute($event)
         if (null === $definition = $event->getEnvironment()->getDataDefinition()) {
             return false;
         }
+
         return ($this->dataContainerName === $definition->getName());
     }
 

src/Contao/Callback/AbstractReturningPropertyCallbackListener.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2020 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -13,7 +13,8 @@
  * @package    contao-community-alliance/dc-general
  * @author     Christian Schiffler <[email protected]>
  * @author     Sven Baumann <[email protected]>
- * @copyright  2013-2020 Contao Community Alliance.
+ * @author     Ingolf Steinhardt <[email protected]>
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -66,7 +67,7 @@ public function setRestrictions(?string $dataContainerName = null, ?string $prop
     public function wantToExecute($event)
     {
         return parent::wantToExecute($event)
-            && (empty($this->propertyName) || ($this->propertyName === $this->getProperty($event)));
+            && (null === $this->propertyName || ($this->propertyName === $this->getProperty($event)));
     }
 
     private function getProperty(Event $event): string

src/Contao/Callback/ContainerGlobalButtonCallbackListener.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -14,7 +14,8 @@
  * @author     Christian Schiffler <[email protected]>
  * @author     Tristan Lins <[email protected]>
  * @author     Sven Baumann <[email protected]>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @author     Ingolf Steinhardt <[email protected]>
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -59,9 +60,7 @@ public function setRestrictions($dataContainerName = null, $operationName = null
     public function wantToExecute($event)
     {
         return parent::wantToExecute($event)
-            && (empty($this->operationName)
-                || ($this->operationName === $event->getKey())
-            );
+            && (null === $this->operationName || ($this->operationName === $event->getKey()));
     }
 
     /**

src/Contao/Callback/ContainerOnLoadCallbackListener.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2019 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -14,7 +14,8 @@
  * @author     Christian Schiffler <[email protected]>
  * @author     Tristan Lins <[email protected]>
  * @author     Sven Baumann <[email protected]>
- * @copyright  2013-2019 Contao Community Alliance.
+ * @author     Ingolf Steinhardt <[email protected]>
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -38,7 +39,7 @@ class ContainerOnLoadCallbackListener extends AbstractCallbackListener
      */
     public function wantToExecute($event)
     {
-        if (empty($this->dataContainerName)) {
+        if (null === $this->dataContainerName) {
             return true;
         }
         if (null === $definition = $event->getDcGeneral()->getEnvironment()->getDataDefinition()) {

src/Contao/Callback/ModelOperationButtonCallbackListener.php

@@ -3,7 +3,7 @@
 /**
  * This file is part of contao-community-alliance/dc-general.
  *
- * (c) 2013-2020 Contao Community Alliance.
+ * (c) 2013-2024 Contao Community Alliance.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -15,7 +15,8 @@
  * @author     Tristan Lins <[email protected]>
  * @author     David Molineus <[email protected]>
  * @author     Sven Baumann <[email protected]>
- * @copyright  2013-2020 Contao Community Alliance.
+ * @author     Ingolf Steinhardt <[email protected]>
+ * @copyright  2013-2024 Contao Community Alliance.
  * @license    https://github.com/contao-community-alliance/dc-general/blob/master/LICENSE LGPL-3.0-or-later
  * @filesource
  */
@@ -69,9 +70,7 @@ public function wantToExecute($event)
         }
 
         return parent::wantToExecute($event)
-        && (empty($this->operationName)
-            || ($this->operationName === $event->getKey())
-        );
+               && (null === $this->operationName || ($this->operationName === $event->getKey()));
     }
 
     /**

src/Contao/Compatibility/DcCompat.php

@@ -206,9 +206,10 @@ public function __get($name)
                 return $dataProvider->getEmptyModel()->getProviderName();
 
             case 'value':
-                if ($this->propertyName && $this->getModel()) {
+                if (null !== $this->propertyName && null !== $this->getModel()) {
                     $model = $this->getModel();
                     assert($model instanceof ModelInterface);
+
                     return $model->getProperty($this->propertyName);
                 }
                 return null;