Merge branch '1.0' into 1.x

pimcore · May 3, 2024 · 74886cd · 74886cd
2 parents de78aa2 + 66920a3
commit 74886cd
Show file tree

Hide file tree

Showing 63 changed files with 62 additions and 461 deletions.
diff --git a/.github/workflows/php-cs-fixer.yaml b/.github/workflows/php-cs-fixer.yaml
@@ -1,10 +1,17 @@
-name: PHP-CS-Fixer
+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
@@ -15,13 +22,14 @@ jobs:
             contents: write  # for stefanzweifel/git-auto-commit-action to push code in repo
         runs-on: ubuntu-latest
         steps:
-            -   uses: actions/checkout@v2
-                with:
-                    ref: ${{ github.head_ref }}
+            - 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
+            - name: PHP-CS-Fixer
+              uses: docker://oskarstark/php-cs-fixer-ga:latest
 
-            -   uses: stefanzweifel/git-auto-commit-action@v4
-                with:
-                    commit_message: Apply php-cs-fixer changes
+            - uses: stefanzweifel/git-auto-commit-action@v5
+              with:
+                  commit_message: Apply php-cs-fixer changes
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -8,20 +8,17 @@
     ->exclude([
         __DIR__ . '/tests/_output',
         __DIR__ . '/tests/Support/_generated',
-    ])
-
-    // do not fix views
-    ->notName('*.html.php');
+    ]);
 
 // 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'],
+    '@PSR1'                  => true,
+    '@PSR2'                  => true,
+    'array_syntax'           => ['syntax' => 'short'],
+    'list_syntax'            => ['syntax' => 'short'],
 
-    'header_comment' => [
+    'header_comment'         => [
         'comment_type' => 'PHPDoc',
         'header' => 'Pimcore' . PHP_EOL . PHP_EOL .
             'This source file is available under two different licenses:' . PHP_EOL .
@@ -34,45 +31,46 @@
             ' @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_unneeded_control_parentheses' => true,
-    'no_unused_imports' => true,
+    '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,
+    '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);

diff --git a/src/Controller/Admin/TargetingController.php b/src/Controller/Admin/TargetingController.php
@@ -45,9 +45,7 @@ private function correctName(string $name): string
     /**
      * @Route("/rule/list", name="pimcore_bundle_personalization_targeting_rulelist", methods={"GET"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function ruleListAction(Request $request): JsonResponse
     {
@@ -72,9 +70,7 @@ public function ruleListAction(Request $request): JsonResponse
     /**
      * @Route("/rule/add", name="pimcore_bundle_personalization_targeting_ruleadd", methods={"POST"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function ruleAddAction(Request $request): JsonResponse
     {
@@ -88,9 +84,7 @@ public function ruleAddAction(Request $request): JsonResponse
     /**
      * @Route("/rule/delete", name="pimcore_bundle_personalization_targeting_ruledelete", methods={"DELETE"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function ruleDeleteAction(Request $request): JsonResponse
     {
@@ -108,9 +102,7 @@ public function ruleDeleteAction(Request $request): JsonResponse
     /**
      * @Route("/rule/get", name="pimcore_bundle_personalization_targeting_ruleget", methods={"GET"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function ruleGetAction(Request $request): JsonResponse
     {
@@ -126,9 +118,7 @@ public function ruleGetAction(Request $request): JsonResponse
     /**
      * @Route("/rule/save", name="pimcore_bundle_personalization_targeting_rulesave", methods={"PUT"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function ruleSaveAction(Request $request): JsonResponse
     {
@@ -150,9 +140,7 @@ public function ruleSaveAction(Request $request): JsonResponse
     /**
      * @Route("/rule/order", name="pimcore_bundle_personalization_targeting_ruleorder", methods={"POST"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function ruleOrderAction(Request $request): JsonResponse
     {
@@ -196,9 +184,7 @@ public function ruleOrderAction(Request $request): JsonResponse
     /**
      * @Route("/target-group/list", name="pimcore_bundle_personalization_targeting_targetgrouplist", methods={"GET"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function targetGroupListAction(Request $request): JsonResponse
     {
@@ -231,10 +217,7 @@ public function targetGroupListAction(Request $request): JsonResponse
     /**
      * @Route("/target-group/add", name="pimcore_bundle_personalization_targeting_targetgroupadd", methods={"POST"})
      *
-     * @param Request $request
-     * @param CoreCacheHandler $cache
      *
-     * @return JsonResponse
      */
     public function targetGroupAddAction(Request $request, CoreCacheHandler $cache): JsonResponse
     {
@@ -251,10 +234,7 @@ public function targetGroupAddAction(Request $request, CoreCacheHandler $cache):
     /**
      * @Route("/target-group/delete", name="pimcore_bundle_personalization_targeting_targetgroupdelete", methods={"DELETE"})
      *
-     * @param Request $request
-     * @param CoreCacheHandler $cache
      *
-     * @return JsonResponse
      */
     public function targetGroupDeleteAction(Request $request, CoreCacheHandler $cache): JsonResponse
     {
@@ -274,9 +254,7 @@ public function targetGroupDeleteAction(Request $request, CoreCacheHandler $cach
     /**
      * @Route("/target-group/get", name="pimcore_bundle_personalization_targeting_targetgroupget", methods={"GET"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function targetGroupGetAction(Request $request): JsonResponse
     {
@@ -292,10 +270,7 @@ public function targetGroupGetAction(Request $request): JsonResponse
     /**
      * @Route("/target-group/save", name="pimcore_bundle_personalization_targeting_targetgroupsave", methods={"PUT"})
      *
-     * @param Request $request
-     * @param CoreCacheHandler $cache
      *
-     * @return JsonResponse
      */
     public function targetGroupSaveAction(Request $request, CoreCacheHandler $cache): JsonResponse
     {

diff --git a/src/Controller/Admin/TargetingPageController.php b/src/Controller/Admin/TargetingPageController.php
@@ -34,9 +34,7 @@ class TargetingPageController extends PageController
     /**
      * @Route("/clear-targeting-editable-data", name="pimcore_bundle_personalization_clear_targeting_page_editable_data", methods={"PUT"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function clearTargetingEditableDataAction(Request $request): JsonResponse
     {
@@ -68,11 +66,6 @@ public function clearTargetingEditableDataAction(Request $request): JsonResponse
     /**
      * @Route("/save", name="pimcore_admin_document_page_save", methods={"PUT", "POST"})
      *
-     * @param Request $request
-     * @param StaticPageGenerator $staticPageGenerator
-     *
-     * @return JsonResponse
-     *
      * @throws \Exception
      */
     public function saveAction(Request $request, StaticPageGenerator $staticPageGenerator): JsonResponse

diff --git a/src/Controller/Admin/TargetingSnippetController.php b/src/Controller/Admin/TargetingSnippetController.php
@@ -33,9 +33,7 @@ class TargetingSnippetController extends SnippetController
     /**
      * @Route("/clear-targeting-editable-data", name="pimcore_bundle_personalization_clear_targeting_snippet_editable_data", methods={"PUT"})
      *
-     * @param Request $request
      *
-     * @return JsonResponse
      */
     public function clearTargetingEditableDataAction(Request $request): JsonResponse
     {
@@ -67,10 +65,6 @@ public function clearTargetingEditableDataAction(Request $request): JsonResponse
     /**
      * @Route("/save", name="pimcore_admin_document_snippet_save", methods={"PUT", "POST"})
      *
-     * @param Request $request
-     *
-     * @return JsonResponse
-     *
      * @throws \Exception
      */
     public function saveAction(Request $request): JsonResponse

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -23,9 +23,6 @@
 
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('pimcore_personalization');

diff --git a/src/Document/Newsletter/AddressSourceAdapter/DefaultAdapter.php b/src/Document/Newsletter/AddressSourceAdapter/DefaultAdapter.php
@@ -69,10 +69,7 @@ protected function getListing(): ?Listing
     /**
      * Handle target group filters
      *
-     * @param ClassDefinition $class
-     * @param array $conditions
      *
-     * @return array
      */
     protected function addTargetGroupConditions(ClassDefinition $class, array $conditions): array
     {

diff --git a/src/Event/Model/TargetGroupEvent.php b/src/Event/Model/TargetGroupEvent.php
@@ -28,8 +28,6 @@ class TargetGroupEvent extends Event
     /**
      * TargetGroupEvent constructor.
      *
-     * @param TargetGroup $targetGroup
-     * @param array $arguments
      */
     public function __construct(TargetGroup $targetGroup, array $arguments = [])
     {

diff --git a/src/Event/Targeting/TargetingCodeEvent.php b/src/Event/Targeting/TargetingCodeEvent.php
@@ -32,9 +32,7 @@ class TargetingCodeEvent extends Event
     private array $data;
 
     /**
-     * @param string $template
      * @param CodeBlock[] $blocks
-     * @param array $data
      */
     public function __construct(
         string $template,

diff --git a/src/Model/Document/Page.php b/src/Model/Document/Page.php
@@ -34,14 +34,12 @@ class Page extends \Pimcore\Model\Document\Page implements TargetingDocumentInte
      *
      * @internal
      *
-     * @var string
      */
     protected string $targetGroupIds = '';
 
     /**
      * Set linked Target Groups as set in properties panel as list of IDs
      *
-     * @param array|string $targetGroupIds
      */
     public function setTargetGroupIds(array|string $targetGroupIds): void
     {
@@ -61,7 +59,6 @@ public function setTargetGroupIds(array|string $targetGroupIds): void
     /**
      * Get serialized list of Target Group IDs
      *
-     * @return string
      */
     public function getTargetGroupIds(): string
     {

diff --git a/src/Model/Document/Snippet.php b/src/Model/Document/Snippet.php
@@ -26,8 +26,5 @@ class Snippet extends \Pimcore\Model\Document\Snippet implements TargetingDocume
 {
     use TargetDocumentTrait;
 
-    /**
-     * {@inheritdoc}
-     */
     protected string $type = 'snippet';
 }
diff --git a/src/Model/Document/Targeting/TargetingDocumentDaoInterface.php b/src/Model/Document/Targeting/TargetingDocumentDaoInterface.php
@@ -22,14 +22,12 @@ interface TargetingDocumentDaoInterface
     /**
      * Checks if the document has targeting specific elements
      *
-     * @return bool
      */
     public function hasTargetGroupSpecificEditables(): bool;
 
     /**
      * Returns targeting specific element names
      *
-     * @return array
      */
     public function getTargetGroupSpecificEditableNames(): array;
 }