Merge pull request #4 from portrino/typo3-v12

TYPO3 v12 Compatibility

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron:  '5 5 * * *'
+
+jobs:
+  testsuite:
+    name: all tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+      - name: "Install PHP"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: none
+          tools: composer:v2
+      - name: "Composer Install"
+        run: "composer install"
+      - name: "Run Static Code Analysis"
+        run: "composer ci:static"
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [ '8.1', '8.2', '8.3' ]

.gitignore

@@ -0,0 +1,9 @@
+.idea/
+.Build/
+Build/phpunit/.phpunit.result.cache
+Build/testing-docker/.env
+var/
+.env
+.php-cs-fixer.cache
+config
+composer.lock

Build/.htaccess

@@ -0,0 +1,2 @@
+Order deny,allow
+Deny from all

Build/.stylelintignore

@@ -0,0 +1,3 @@
+**/*.min.css
+**/Dist/
+**/Vendor/

Build/.stylelintrc

@@ -0,0 +1,15 @@
+{
+    "extends": [
+        "stylelint-config-twbs-bootstrap/scss"
+    ],
+    "rules": {
+        "property-blacklist": [
+            "border-radius",
+            "border-top-left-radius",
+            "border-top-right-radius",
+            "border-bottom-right-radius",
+            "border-bottom-left-radius",
+            "transition"
+        ]
+    }
+}

Build/php-cs-fixer.php

@@ -0,0 +1,5 @@
+<?php
+
+$config = \TYPO3\CodingStandards\CsFixerConfig::create();
+$config->getFinder()->exclude(['node_modules', 'var'])->in(__DIR__ . '/..');
+return $config;

Build/phpstan.neon

@@ -0,0 +1,13 @@
+includes:
+	- %currentWorkingDirectory%/.Build/vendor/phpstan/phpstan-strict-rules/rules.neon
+	- %currentWorkingDirectory%/.Build/vendor/phpstan/phpstan-deprecation-rules/rules.neon
+	- %currentWorkingDirectory%/.Build/vendor/friendsoftypo3/phpstan-typo3/extension.neon
+
+parameters:
+  level: 5
+
+  paths:
+    - %currentWorkingDirectory%/Classes
+  excludePaths:
+      analyse:
+          - %currentWorkingDirectory%/Classes/Reflection/ClassSchema.php

Build/typoscript-lint.yaml

@@ -0,0 +1,16 @@
+paths:
+  - Configuration/TypoScript
+
+sniffs:
+  - class: Indentation
+    parameters:
+      useSpaces: true
+      indentPerLevel: 4
+  - class: DeadCode
+    disabled: true
+  - class: EmptySection
+    disabled: true
+  - class: RepeatingRValue
+    disabled: true
+  - class: NestingConsistency
+    disabled: true

CHANGELOG.md

@@ -1,5 +1,14 @@
 # PxValidation Changelog
 
+#### 2024-04-22
+* [!!!][WIP] updates several classes for TYPO3 v12 compatibility
+* [TASK] adds .github/workflow
+* [CLEANUP] updates CHANGELOG and README
+
+#### 2023-03-03
+* [TASK] updates several classes and configuration files to be compatible with TYPO3 v12 core
+* [TASK] adds TYPO3 v12 to allowed typo3/cms-core dependency
+
 3.0.0 - 2023-03-17
 ------------------
 * [CLEANUP] updates CHANGELOG and README

Classes/Domain/Validator/AbstractValidator.php

@@ -30,36 +30,32 @@
 use Portrino\PxValidation\Validation\ValidatorResolver;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Annotation\Validate;
-use TYPO3\CMS\Extbase\Configuration\ConfigurationManager;
 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
 use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
 use TYPO3\CMS\Extbase\Validation\Exception\NoSuchValidatorException;
 use TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator;
 
 /**
  * Class AbstractValidator
- *
- * @package Portrino\PxValidation\Domain\Validator
  */
 abstract class AbstractValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
 {
-
     /**
      * Contains the settings of the current extension
      *
      * @var array
      */
-    protected $settings;
+    protected $settings = [];
 
     /**
      * Contains the settings of the current extension
      *
      * @var array
      */
-    protected $validationFields;
+    protected $validationFields = [];
 
     /**
-     * @var ConfigurationManager
+     * @var ConfigurationManagerInterface
      */
     protected $configurationManager;
 
@@ -68,13 +64,11 @@ abstract class AbstractValidator extends \TYPO3\CMS\Extbase\Validation\Validator
      */
     protected $validatorResolver;
 
-    public function __construct(array $options = [])
+    public function __construct()
     {
-        parent::__construct($options);
-
         $this->configurationManager = GeneralUtility::makeInstance(ConfigurationManagerInterface::class);
         $this->settings = $this->configurationManager->getConfiguration(
-            ConfigurationManager::CONFIGURATION_TYPE_SETTINGS,
+            ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS,
             'PxValidation'
         );
         $this->validatorResolver = GeneralUtility::makeInstance(ValidatorResolver::class);
@@ -85,12 +79,9 @@ public function __construct(array $options = [])
      *
      * @param mixed $object
      * @throws Exception
-     *
-     * @return bool
      */
-    public function isValid($object)
+    protected function isValid(mixed $object): void
     {
-        $result = true;
         $this->validationFields = $this->getValidationFields();
 
         $objectValidators = new ObjectStorage();
@@ -111,7 +102,7 @@ public function isValid($object)
                     );
                     if ($newValidator === null) {
                         throw new NoSuchValidatorException(
-                            'Invalid typoscript validation rule in ' . $object . '::' . $validationRule . ': Could not resolve class name for  validator "' . $validatorConfiguration['validatorName'] . '".',
+                            'Invalid typoscript validation rule in ' . $object . '::' . $validationRule . ': Could not resolve class name for  validator "' . $validateAnnotation['validatorName'] . '".',
                             1241098027
                         );
                     }
@@ -124,7 +115,6 @@ public function isValid($object)
         if (array_key_exists('propertyValidators', $this->validationFields) &&
             is_array($this->validationFields['propertyValidators'])) {
             foreach ($this->validationFields['propertyValidators'] as $validationField => $validationRules) {
-
                 /**
                  *  if the property to validate is a child property then create a new $typoScriptChildValidator
                  *  with the validation config of the child
@@ -169,6 +159,7 @@ public function isValid($object)
                 }
             }
         }
+        unset($objectValidator);
 
         foreach ($objectValidators as $objectValidator) {
             if ($objectValidator instanceof TypoScriptChildValidator) {
@@ -178,18 +169,13 @@ public function isValid($object)
             } else {
                 $this->result->merge($objectValidator->validate($object));
             }
-
-            if ($this->result->hasErrors()) {
-                $result = false;
-            }
         }
-        return $result;
     }
 
     /**
      * returns the array of validation fields from typoScript
      *
      * @return array
      */
-    abstract protected function getValidationFields();
+    abstract protected function getValidationFields(): array;
 }

Classes/Domain/Validator/TypoScriptChildValidator.php

@@ -28,19 +28,16 @@
 
 /**
  * Class TypoScriptChildValidator
- * @package Portrino\PxValidation\Domain\Validator
  */
 class TypoScriptChildValidator extends \Portrino\PxValidation\Domain\Validator\TypoScriptValidator
 {
-
     /**
      * the child property name which will be validated
      *
      * @var mixed
      */
     protected $childPropertyName;
 
-
     /**
      * the child object to validate
      *
@@ -51,7 +48,7 @@ class TypoScriptChildValidator extends \Portrino\PxValidation\Domain\Validator\T
     /**
      * @param array $validationFields
      */
-    public function setValidationFields($validationFields)
+    public function setValidationFields(array $validationFields): void
     {
         $this->validationFields = $validationFields;
     }
@@ -61,39 +58,39 @@ public function setValidationFields($validationFields)
      *
      * @return array
      */
-    protected function getValidationFields()
+    protected function getValidationFields(): array
     {
         return $this->validationFields;
     }
 
     /**
      * @return mixed
      */
-    public function getChildPropertyName()
+    public function getChildPropertyName(): mixed
     {
         return $this->childPropertyName;
     }
 
     /**
      * @param mixed $childPropertyName
      */
-    public function setChildPropertyName($childPropertyName)
+    public function setChildPropertyName(mixed $childPropertyName): void
     {
         $this->childPropertyName = $childPropertyName;
     }
 
     /**
      * @return mixed
      */
-    public function getChildObject()
+    public function getChildObject(): mixed
     {
         return $this->childObject;
     }
 
     /**
      * @param mixed $childObject
      */
-    public function setChildObject($childObject)
+    public function setChildObject(mixed $childObject): void
     {
         $this->childObject = $childObject;
     }

Classes/Domain/Validator/TypoScriptValidator.php

@@ -28,12 +28,9 @@
 
 /**
  * Class TypoScriptValidator
- *
- * @package Portrino\PxValidation\Domain\Validator
  */
 class TypoScriptValidator extends \Portrino\PxValidation\Domain\Validator\AbstractValidator
 {
-
     /**
      * @var array
      */
@@ -44,16 +41,16 @@ class TypoScriptValidator extends \Portrino\PxValidation\Domain\Validator\Abstra
         'overwriteDefaultValidation' => [
             '',
             'If TRUE the validation rules defined in the property, model or controller are overwritten (will not be executed).',
-            'boolean'
-        ]
+            'boolean',
+        ],
     ];
 
     /**
      * returns the array of validation fields from typoscript
      *
      * @return array
      */
-    protected function getValidationFields()
+    protected function getValidationFields(): array
     {
         $result = [];
         $className = $this->options['className'];
@@ -68,10 +65,10 @@ protected function getValidationFields()
     }
 
     /**
-     * @return boolean
+     * @return bool
      */
-    public function overwriteDefaultValidation()
+    public function overwriteDefaultValidation(): bool
     {
-        return (boolean)$this->options['overwriteDefaultValidation'];
+        return (bool)$this->options['overwriteDefaultValidation'];
     }
 }