Merge remote-tracking branch 'origin/4.0' into 4.x

.github/workflows/php-cs-fixer.yaml

@@ -0,0 +1,35 @@
+name: "PHP-CS-Fixer"
+
+on:
+    pull_request_target:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+            - "feature-*"
+    push:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+            - "*_actions"
+            - "feature-*"
+
+permissions:
+    contents: read
+
+jobs:
+    php-cs-fixer:
+        permissions:
+            contents: write  # for stefanzweifel/git-auto-commit-action to push code in repo
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.event.pull_request.head.ref }}
+                  repository: ${{ github.event.pull_request.head.repo.full_name }}
+
+            - name: PHP-CS-Fixer
+              uses: docker://oskarstark/php-cs-fixer-ga:latest
+
+            - uses: stefanzweifel/git-auto-commit-action@v5
+              with:
+                  commit_message: Apply php-cs-fixer changes

.gitignore

@@ -12,7 +12,7 @@ Thumbs.db
 
 # PHP-CS-Fixer
 /.php_cs
-/.php_cs.cache
+/.php-cs-fixer.cache
 
 # composer
 /composer.lock

.php-cs-fixer.dist.php

@@ -0,0 +1,79 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+
+    ->exclude([
+        __DIR__ . '/tests/_output',
+        __DIR__ . '/tests/_support/_generated',
+    ])
+;
+
+// do not enable self_accessor as it breaks pimcore models relying on get_called_class()
+$config = new PhpCsFixer\Config();
+$config->setRules([
+    '@PSR1'                  => true,
+    '@PSR2'                  => true,
+    'array_syntax'           => ['syntax' => 'short'],
+    'list_syntax'            => ['syntax' => 'short'],
+
+    'header_comment'         => [
+        'comment_type' => 'PHPDoc',
+        'header' => 'Pimcore' . PHP_EOL . PHP_EOL .
+            'This source file is available under two different licenses:' . PHP_EOL .
+            '- GNU General Public License version 3 (GPLv3)' . PHP_EOL .
+            '- Pimcore Commercial License (PCL)' . PHP_EOL .
+            'Full copyright and license information is available in' . PHP_EOL .
+            'LICENSE.md which is distributed with this source code.' . PHP_EOL .
+            PHP_EOL .
+            ' @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)' . PHP_EOL .
+            ' @license    http://www.pimcore.org/license     GPLv3 and PCL'
+    ],
+
+    'blank_line_before_statement'         => true,
+    'encoding'                            => true,
+    'function_typehint_space'             => true,
+    'single_line_comment_style'           => true,
+    'lowercase_cast'                      => true,
+    'magic_constant_casing'               => true,
+    'method_argument_space'               => ['on_multiline' => 'ignore'],
+    'class_attributes_separation'         => true,
+    'native_function_casing'              => true,
+    'no_blank_lines_after_class_opening'  => true,
+    'no_blank_lines_after_phpdoc'         => true,
+    'no_empty_comment'                    => true,
+    'no_empty_phpdoc'                     => true,
+    'no_empty_statement'                  => true,
+    'no_extra_blank_lines'                => true,
+    'no_leading_import_slash'             => true,
+    'no_leading_namespace_whitespace'     => true,
+    'no_short_bool_cast'                  => true,
+    'no_spaces_around_offset'             => true,
+    'no_superfluous_phpdoc_tags'          => ['allow_mixed' => true, 'remove_inheritdoc' => true],
+    'no_unneeded_control_parentheses'     => true,
+    'no_unused_imports'                   => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line'         => true,
+    'object_operator_without_whitespace'  => true,
+    'ordered_imports'                     => true,
+    'phpdoc_indent'                       => true,
+    'phpdoc_no_useless_inheritdoc'        => true,
+    'phpdoc_scalar'                       => true,
+    'phpdoc_separation'                   => true,
+    'phpdoc_single_line_var_spacing'      => true,
+    'return_type_declaration'             => true,
+    'short_scalar_cast'                   => true,
+    'single_blank_line_before_namespace'  => true,
+    'single_quote'                        => true,
+    'space_after_semicolon'               => true,
+    'standardize_not_equals'              => true,
+    'ternary_operator_spaces'             => true,
+    'trailing_comma_in_multiline'         => true,
+    'whitespace_after_comma_in_array'     => true,
+]);
+
+$config->setFinder($finder);
+return $config;

README.md

@@ -29,7 +29,7 @@ For a first impression have a look at our [Demo](https://demo.pimcore.fun/). For
 The following sections provide shortcuts into the documentation to start working with the Customer Management Framework (CMF) for Pimcore: 
 - See the [Getting Started](#getting-started) section for an overview of the CMF Framework architecture or information about the installation process.
 - See the [Customer-Related Data](#customer-related-data) section for details about the management of customer-related data with the CMF Framework.
-- See the [Platform Topics](#platform-topics) section for documentation about services provided by the CMF Framework.
+- See the [Provided Services](#provided-services) section for documentation about services provided by the CMF Framework.
 
 ### Getting Started
 * [Architecture Overview](./doc/01_Architecture-Overview.md)

phpstan-baseline.neon

@@ -1,25 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/ActionTrigger/EventHandler/DefaultEventHandler.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/Controller/Admin/ActivitiesController.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 2
-			path: src/Controller/Admin/CustomersController.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/Controller/Admin/DuplicatesController.php
-
 		-
 			message: "#^Parameter \\#1 \\$segments of class CustomerManagementFrameworkBundle\\\\CustomerList\\\\Filter\\\\CustomerSegment constructor expects array\\<Pimcore\\\\Model\\\\DataObject\\\\CustomerSegment\\>, array\\<int\\<0, max\\>, CustomerManagementFrameworkBundle\\\\Model\\\\CustomerSegmentInterface\\> given\\.$#"
 			reportUnmatched: false
@@ -37,11 +17,6 @@ parameters:
 			count: 1
 			path: src/CustomerView/DefaultCustomerView.php
 
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/DuplicatesIndex/DefaultMariaDbDuplicatesIndex.php
-
 		-
 			message: "#^Result of && is always false\\.$#"
 			count: 1
@@ -107,41 +82,11 @@ parameters:
 			count: 1
 			path: src/Newsletter/ProviderHandler/Mailchimp/CliSyncProcessor.php
 
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 2
-			path: src/Newsletter/Queue/DefaultNewsletterQueue.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/RESTApi/CustomersHandler.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/RESTApi/SegmentGroupsHandler.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/RESTApi/SegmentsHandler.php
-
 		-
 			message: "#^Call to an undefined method CustomerManagementFrameworkBundle\\\\RESTApi\\\\SegmentsOfCustomerHandler\\:\\:createRoute\\(\\)\\.$#"
 			count: 1
 			path: src/RESTApi/SegmentsOfCustomerHandler.php
 
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/SegmentBuilder/AgeSegmentBuilder.php
-
-		-
-			message: "#^Call to an undefined method Knp\\\\Component\\\\Pager\\\\Pagination\\\\PaginationInterface\\:\\:getPaginationData\\(\\)\\.$#"
-			count: 1
-			path: src/SegmentManager/SegmentBuilderExecutor/DefaultSegmentBuilderExecutor.php
-
 		-
 			message: "#^If condition is always false\\.$#"
 			count: 1

src/ActionTrigger/Action/AddTrackedSegment.php

@@ -24,7 +24,9 @@
 class AddTrackedSegment extends AbstractAction
 {
     const OPTION_REMOVE_OTHER_SEGMENTS_FROM_SEGMENT_GROUP = 'removeOtherSegmentsFromGroup';
+
     const OPTION_INCREASE_SEGMENT_APPLICATION_COUNTER = 'increaseSegmentApplicationCounter';
+
     const OPTION_CONSIDER_PROFILING_CONSENT = 'considerProfilingConsent';
 
     protected $name = 'AddTrackedSegment';

src/ActionTrigger/Action/ChangeFieldValue.php

@@ -21,6 +21,7 @@
 class ChangeFieldValue extends AbstractAction
 {
     const OPTION_FIELD = 'field';
+
     const OPTION_VALUE = 'value';
 
     public function process(

src/ActionTrigger/Action/SendMail.php

@@ -23,8 +23,11 @@
 class SendMail extends AbstractAction
 {
     const OPTION_CONSIDER_PROFILING_CONSENT = 'considerProfilingConsent';
+
     const OPTION_EMAIL_DOCUMENT = 'emailDoc';
+
     const OPTION_SEND_TO_CUSTOMER = 'toCustomer';
+
     protected $name = 'SendMail';
 
     public function process(

src/ActionTrigger/Condition/ConditionDefinitionInterface.php

@@ -40,7 +40,6 @@ public function getDefinitionData();
     public function getOptions();
 
     /**
-     * @param array $options
      *
      * @return void
      */

src/ActionTrigger/Condition/ConditionInterface.php

@@ -24,14 +24,10 @@ interface ConditionInterface
     /**
      * ConditionInterface constructor.
      *
-     * @param LoggerInterface $logger
      */
     public function __construct(LoggerInterface $logger);
 
     /**
-     * @param ConditionDefinitionInterface $conditionDefinition
-     * @param CustomerInterface $customer
-     * @param RuleEnvironmentInterface $environment
      *
      * @return bool
      */
@@ -42,7 +38,6 @@ public function check(
     );
 
     /**
-     * @param ConditionDefinitionInterface $conditionDefinition
      *
      * @return string
      */
@@ -56,7 +51,6 @@ public function getDbCondition(ConditionDefinitionInterface $conditionDefinition
     public static function createConditionDefinitionFromEditmode($setting);
 
     /**
-     * @param ConditionDefinitionInterface $conditionDefinition
      *
      * @return array
      */

src/ActionTrigger/Condition/CountActivities.php

@@ -23,7 +23,9 @@
 class CountActivities extends AbstractMatchCondition
 {
     const OPTION_TYPE = 'type';
+
     const OPTION_COUNT = 'count';
+
     const OPTION_OPERATOR = 'operator';
 
     public function check(

src/ActionTrigger/Condition/CountTargetGroupWeight.php

@@ -22,7 +22,9 @@
 class CountTargetGroupWeight extends AbstractMatchCondition
 {
     const OPTION_OPERATOR = 'operator';
+
     const OPTION_COUNT = 'count';
+
     const OPTION_TARGET_GROUP = 'targetGroup';
 
     public function check(