Update for translation handling and support arbitrary routing

- Translate operation button labels and descriptions correctly including fallback to old style translation files - Translate global operation button labels and descriptions correctly including fallback to old style translation files - Correct translation key for editAll button - Fix URL generating in CopyHandler - Translate property names in SelectAllHandler correctly - Translate property names in parent view header correctly - Change various translation keys from .0 => .label etc. - Fix URL generating in ClipboardController - Really check permission for excluded fields instead of returning always false - Handle translations in WidgetBuilder - Support arbitrary routes in `ViewHelpers::redirectHome` - Update referers in session for routes with attribute `_dcg_referer_update` (As Contao does for DC_Table) - Translate properties in panel elements
contao-community-alliance · May 15, 2024 · 29999a3 · 29999a3
1 parent bb6ddc0
commit 29999a3
Show file tree

Hide file tree

Showing 69 changed files with 1,771 additions and 1,286 deletions.
diff --git a/.composer-require-checker.json b/.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",

diff --git a/composer.json b/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"
   }
 }
diff --git a/src/BaseConfigRegistry.php b/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);
         }
 

diff --git a/src/Contao/Callback/AbstractCallbackListener.php b/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());
     }
 

diff --git a/src/Contao/Callback/AbstractReturningPropertyCallbackListener.php b/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

diff --git a/src/Contao/Callback/ContainerGlobalButtonCallbackListener.php b/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()));
     }
 
     /**

diff --git a/src/Contao/Callback/ContainerOnLoadCallbackListener.php b/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()) {

diff --git a/src/Contao/Callback/ModelOperationButtonCallbackListener.php b/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()));
     }
 
     /**

diff --git a/src/Contao/Compatibility/DcCompat.php b/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;

diff --git a/src/Contao/Dca/Builder/Legacy/ExtendedLegacyDcaDataDefinitionBuilder.php b/src/Contao/Dca/Builder/Legacy/ExtendedLegacyDcaDataDefinitionBuilder.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.
@@ -16,7 +16,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
  */
@@ -118,7 +118,7 @@ function (PopulateEnvironmentEvent $event) use ($dataContainerName) {
                     }
 
                     $parentName = $definition->getBasicDefinition()->getParentDataProvider();
-                    if ($parentName) {
+                    if (null !== $parentName) {
                         $parentDefinition = ($parentName === $definition->getName())
                             ? $definition
                             : (new DcGeneralFactory())
@@ -133,7 +133,7 @@ function (PopulateEnvironmentEvent $event) use ($dataContainerName) {
                     }
 
                     $rootName = $definition->getBasicDefinition()->getRootDataProvider();
-                    if ($rootName) {
+                    if (null !== $rootName) {
                         $rootDefinition = ($rootName === $definition->getName())
                             ? $definition
                             : (new DcGeneralFactory())
@@ -221,13 +221,13 @@ protected function parseSingleDataProvider(
         ContainerInterface $container,
         DataProviderDefinitionInterface $providers,
         array $information,
-        $name
+        ?string $name
     ) {
         if (isset($information['factory'])) {
             $providerInformation = (new \ReflectionClass($information['factory']))->newInstance()->build($information);
         } else {
             // Determine the name.
-            if ($name && !$this->isSpecialName($name)) {
+            if (null !== $name && !$this->isSpecialName($name)) {
                 $providerName = $name;
             } elseif ('default' === $name) {
                 $providerName = $container->getName();
@@ -249,13 +249,11 @@ protected function parseSingleDataProvider(
             if (!$providerInformation instanceof ContaoDataProviderInformation) {
                 return $providerInformation;
             }
-            if (!$providerInformation->getTableName()) {
+            if (null === $providerInformation->getTableName()) {
                 if (isset($information['source'])) {
-                    $providerInformation
-                        ->setTableName($information['source']);
+                    $providerInformation->setTableName($information['source']);
                 } else {
-                    $providerInformation
-                        ->setTableName($providerName);
+                    $providerInformation->setTableName($providerName);
                 }
             }
 
@@ -384,7 +382,7 @@ protected function parseRootCondition(
         if (null !== ($rootCondition = $this->getFromDca('dca_config/rootEntries'))) {
             $rootProvider = $container->getBasicDefinition()->getRootDataProvider();
 
-            if (!$rootProvider) {
+            if (null === $rootProvider) {
                 throw new DcGeneralRuntimeException(
                     'Root data provider name not specified in DCA but rootEntries section specified.'
                 );