Merge pull request #53 from dachcom-digital/p11

Pimcore 11 Support

.github/workflows/codeception.yml

@@ -15,10 +15,10 @@ jobs:
             TEST_PROJECT_ROOT_DIR: "${{ github.workspace }}"
 
             PIMCORE_CODECEPTION_FRAMEWORK: "${{ github.workspace }}/pimcore-codeception-framework"
-            PIMCORE_CODECEPTION_VERSION: "2.0"
+            PIMCORE_CODECEPTION_VERSION: "3.0"
 
             APP_ENV: test
-            PIMCORE_TEST_DB_DSN: "mysql://root:root@127.0.0.1:3306/dachcom_bundle_test"
+            PIMCORE_TEST_DB_DSN: "mysql://test:test@127.0.0.1:3306/dachcom_bundle_test"
             PIMCORE_TEST_URL: "http://localhost"
             PIMCORE_CLASS_DIRECTORY: "${{ github.workspace }}/lib/test-bundle/tests/_output/var/classes/DataObject"
 
@@ -38,12 +38,12 @@ jobs:
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
         strategy:
             matrix:
-                php: [ 8.1 ]
-                symfony: [ ^5.4 ]
-                pimcore: [ ~10.6.0 ]
+                php: [ 8.2 ]
+                symfony: [ ^6.2 ]
+                pimcore: [ ~11.0.0 ]
                 include:
-                    -   pimcore: ~10.6.0
-                        template_tag: v10.2.5
+                    -   pimcore: ~11.0.0
+                        template_tag: v11.0.0
         steps:
             -   uses: actions/checkout@v2
                 with:
@@ -82,9 +82,19 @@ jobs:
                 run: php -v
 
             -   name: Setup MySql
-                run: |
-                    sudo systemctl start mysql
-                    mysql -uroot -proot -h127.0.0.1 -e "CREATE DATABASE dachcom_bundle_test CHARSET=utf8mb4;"
+                uses: shogo82148/actions-setup-mysql@v1
+                with:
+                    mysql-version: '8.0'
+                    user: test
+                    password: test
+                    root-password: root
+                    auto-start: true
+                    my-cnf: |
+                        max_allowed_packet=32505856
+                        max_connections=1000
+
+            -   name: Initial Database
+                run: mysql -utest -ptest -h127.0.0.1 -e 'CREATE DATABASE dachcom_bundle_test CHARSET=utf8mb4;'
 
             -   name: Setup Chromium
                 run: |

.github/workflows/ecs.yml

@@ -15,7 +15,7 @@ jobs:
             TEST_PROJECT_ROOT_DIR: "${{ github.workspace }}"
 
             PIMCORE_CODECEPTION_FRAMEWORK: "${{ github.workspace }}/pimcore-codeception-framework"
-            PIMCORE_CODECEPTION_VERSION: "2.0"
+            PIMCORE_CODECEPTION_VERSION: "3.0"
 
             APP_ENV: test
             PIMCORE_TEST_DB_DSN: "mysql://root:root@127.0.0.1:3306/dachcom_bundle_test"
@@ -37,12 +37,12 @@ jobs:
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
         strategy:
             matrix:
-                php: [ 8.1 ]
-                symfony: [ ^5.4 ]
-                pimcore: [ ~10.6.0 ]
+                php: [ 8.2 ]
+                symfony: [ ^6.2 ]
+                pimcore: [ ~11.0.0 ]
                 include:
-                    -   pimcore: ~10.6.0
-                        template_tag: v10.2.5
+                    -   pimcore: ~11.0.0
+                        template_tag: v11.0.0
         steps:
             -   uses: actions/checkout@v2
                 with:

.github/workflows/php-stan.yml

@@ -15,7 +15,7 @@ jobs:
             TEST_PROJECT_ROOT_DIR: "${{ github.workspace }}"
 
             PIMCORE_CODECEPTION_FRAMEWORK: "${{ github.workspace }}/pimcore-codeception-framework"
-            PIMCORE_CODECEPTION_VERSION: "2.0"
+            PIMCORE_CODECEPTION_VERSION: "3.0"
 
             APP_ENV: test
             PIMCORE_TEST_DB_DSN: "mysql://root:root@127.0.0.1:3306/dachcom_bundle_test"
@@ -37,12 +37,12 @@ jobs:
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
         strategy:
             matrix:
-                php: [ 8.1 ]
-                symfony: [ ^5.4 ]
-                pimcore: [ ~10.6.0 ]
+                php: [ 8.2 ]
+                symfony: [ ^6.2 ]
+                pimcore: [ ~11.0.0 ]
                 include:
-                    -   pimcore: ~10.6.0
-                        template_tag: v10.2.5
+                    -   pimcore: ~11.0.0
+                        template_tag: v11.0.0
         steps:
             -   uses: actions/checkout@v2
                 with:

LICENSE.md

@@ -1,5 +1,5 @@
 # License
-Copyright (C) 2021 DACHCOM.DIGITAL
+Copyright (C) 2023 DACHCOM.DIGITAL
 
 This software is available under the GNU General Public License version 3 (GPLv3).
 

README.md

@@ -26,19 +26,26 @@ The last SEO Bundle for pimcore you'll ever need!
 
 | Release | Supported Pimcore Versions | Supported Symfony Versions | Release Date | Maintained     | Branch |
 |---------|----------------------------|----------------------------|--------------|----------------|--------|
-| **2.x** | `10.1` - `10.6`            | `5.4`                      | 14.10.2020   | Feature Branch | master |
+| **3x**  | `11.0`                     | `6.2`                      | --           | Feature Branch | master |
+| **2.x** | `10.1` - `10.6`            | `5.4`                      | 14.10.2020   | Bugfixes       | 2.x    |
 | **1.x** | `6.0` - `6.9`              | `3.4`, `^4.4`              | 27.04.2020   | Unsupported    | 1.x    |
 
 
 ## Installation
 
 ```json
 "require" : {
-    "dachcom-digital/seo" : "~2.2.0",
+    "dachcom-digital/seo" : "~3.0.0",
 }
 ```
 
-- Execute: `$ bin/console pimcore:bundle:enable SeoBundle`
+Add Bundle to `bundles.php`:
+```php
+return [
+    SeoBundle\SeoBundle::class => ['all' => true],
+];
+```
+
 - Execute: `$ bin/console pimcore:bundle:install SeoBundle`
 
 ## Upgrading

UPGRADE.md

@@ -1,22 +1,18 @@
 # Upgrade Notes
 
-## 2.2.0
-- [BUGFIX] fix encoding in schema json validation process [#45](https://github.com/dachcom-digital/pimcore-seo/issues/45)
-- [IMPROVEMENT] Respect Pimcore fallback languages [#44](https://github.com/dachcom-digital/pimcore-seo/issues/44)
-
-## 2.1.0
-- [BUGFIX] Fix Array Merge Process [#32](https://github.com/dachcom-digital/pimcore-seo/issues/32)
-- [BUGFIX] Avoid triggering deprecation message on isMasterRequest() [#36](https://github.com/dachcom-digital/pimcore-seo/pull/36)
-- [BUGFIX] Support CoreShop 3 Thumbnails [@dkarlovi](https://github.com/dachcom-digital/pimcore-seo/pull/30)
-- [IMPROVEMENT] Avoid duplicate integrator registration [#28](https://github.com/dachcom-digital/pimcore-seo/issues/28)
-- [IMPROVEMENT] Allow preview images with spaces [#35](https://github.com/dachcom-digital/pimcore-seo/issues/35)
-- [NEW FEATURE]  Add presets to html tag integrator [#37](https://github.com/dachcom-digital/pimcore-seo/issues/37)
-
-## Migrating from Version 1.x to Version 2.0.0
+## Migrating from Version 2.x to Version 3.0.0
+- Execute: `bin/console doctrine:migrations:migrate --prefix 'SeoBundle\Migrations'`
 
 ### Global Changes
-- PHP8 return type declarations added: you may have to adjust your extensions accordingly
+- Recommended folder structure by symfony adopted
+- SEO changes are not getting persisted at auto-save events anymore
+
+### New Features
+- Xliff Import/Export Support, see [#31](https://github.com/dachcom-digital/pimcore-seo/issues/31)
+    - Introduced `XliffAwareIntegratorInterface` to specify xliff translation states for given integrator
+    - Properties for `OpenGraph` and `TwitterCard` integrator can be extended by an 3. argument to include/exclude them for xliff translations (Default `false`)
+- Seo Document Editor Support, see [#54](https://github.com/dachcom-digital/pimcore-seo/issues/54)
 
 ***
 
-SeoBundle 1.x Upgrade Notes: https://github.com/dachcom-digital/pimcore-seo/blob/1.x/UPGRADE.md
+SeoBundle 2.x Upgrade Notes: https://github.com/dachcom-digital/pimcore-seo/blob/2.x/UPGRADE.md

codeception.dist.yml

@@ -1,14 +1,15 @@
 namespace: DachcomBundle\Test
+support_namespace: Support
 actor: Tester
 paths:
     tests: tests
-    output: tests/_output
-    data: tests/_data
-    support: tests/_support
     envs: tests/_envs
+    output: tests/_output
     log: tests/_output/var/logs
+    data: tests/_data
+    support: tests/Support
+bootstrap: _bootstrap.php
 settings:
-    bootstrap: _bootstrap.php
     memory_limit: -1
     colors: true
 params:

composer.json

@@ -15,7 +15,7 @@
     ],
     "autoload": {
         "psr-4": {
-            "SeoBundle\\": "src/SeoBundle"
+            "SeoBundle\\": "src/"
         }
     },
     "autoload-dev": {
@@ -31,16 +31,16 @@
         }
     },
     "require": {
-        "pimcore/pimcore": "^10.1",
+        "pimcore/pimcore": "^11.0",
         "google/apiclient": "^2.0",
         "doctrine/orm": "^2.7"
     },
     "require-dev": {
-        "codeception/codeception": "^4.1",
-        "codeception/module-webdriver": "^1.4",
-        "codeception/module-symfony": "^1.6",
-        "phpstan/phpstan": "^0.12",
-        "phpstan/phpstan-symfony": "^0.12",
+        "codeception/codeception": "^5.0",
+        "codeception/module-symfony": "^3.1",
+        "codeception/module-webdriver": "^4.0",
+        "phpstan/phpstan": "^1.0",
+        "phpstan/phpstan-symfony": "^1.0",
         "symplify/easy-coding-standard": "^9.0"
     },
     "suggest": {

src/SeoBundle/Resources/config/doctrine/model/QueueEntry.orm.yml → config/doctrine/model/QueueEntry.orm.yml

@@ -1,13 +1,16 @@
 SeoBundle\Model\QueueEntry:
     type: entity
     table: seo_queue_entry
-    fields:
+    id:
         uuid:
+            unique: true
             column: uuid
-            id: true
-            type: string
+            type: uuid
             generator:
-                strategy: UUID
+                strategy: CUSTOM
+            customIdGenerator:
+                class: Symfony\Bridge\Doctrine\IdGenerator\UuidGenerator
+    fields:
         type:
             column: '`type`'
             nullable: false

src/SeoBundle/Resources/install/sql/install.sql → config/install/sql/install.sql

@@ -9,7 +9,7 @@ CREATE TABLE IF NOT EXISTS `seo_element_meta_data` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC;
 
 CREATE TABLE IF NOT EXISTS `seo_queue_entry` (
-  `uuid` varchar(255) NOT NULL,
+  `uuid` binary(16) NOT NULL COMMENT '(DC2Type:uuid)',
   `type` varchar(255) NOT NULL,
   `data_type` varchar(255) NOT NULL,
   `data_id` int(11) NOT NULL,

src/SeoBundle/Resources/config/pimcore/config.yml → config/pimcore/config.yaml

@@ -7,4 +7,4 @@ doctrine:
 
 doctrine_migrations:
     migrations_paths:
-        'SeoBundle\Migrations': '@SeoBundle/Migrations'
+        'SeoBundle\Migrations': '@SeoBundle/src/Migrations'

config/services.yaml

@@ -0,0 +1,2 @@
+imports:
+    - { resource: services/*.yaml }

src/SeoBundle/Resources/config/services/controller.yml → config/services/controller.yaml

@@ -1,7 +1,7 @@
 services:
 
     SeoBundle\Controller\:
-        resource: '../../Controller'
+        resource: '../../src/Controller'
         public: true
         autowire: true
         autoconfigure: true

src/SeoBundle/Resources/config/services/event_listener.yml → config/services/event_listener.yaml

@@ -5,6 +5,10 @@ services:
         autoconfigure: true
         public: false
 
+    SeoBundle\EventListener\Admin\AssetListener:
+        tags:
+            - { name: kernel.event_subscriber }
+
     SeoBundle\EventListener\PimcoreElementListener:
         arguments:
             $enabled: '%seo.index.pimcore_element_watcher.enabled%'

config/services/logger.yaml

@@ -0,0 +1,18 @@
+services:
+
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    seo.application_logger.seo_logger:
+        public: true
+        class: Pimcore\Bundle\ApplicationLoggerBundle\ApplicationLogger
+        calls:
+            - [addWriter, ['@Pimcore\Bundle\ApplicationLoggerBundle\Handler\ApplicationLoggerDb']]
+            - [setComponent, ['seo-bundle']]
+
+    SeoBundle\Logger\LoggerInterface: '@SeoBundle\Logger\Logger'
+    SeoBundle\Logger\Logger:
+        arguments:
+            - '@seo.application_logger.seo_logger'

src/SeoBundle/Resources/config/services/extractors/coreshop.yml → config/services/third_party/coreshop.yaml

@@ -7,8 +7,8 @@ services:
 
     SeoBundle\MetaData\Extractor\ThirdParty\CoreShop\TitleDescriptionExtractor:
         tags:
-            - {name: seo.meta_data.extractor, identifier: coreshop_title_description, priority: 10 }
+            - { name: seo.meta_data.extractor, identifier: coreshop_title_description, priority: 10 }
 
     SeoBundle\MetaData\Extractor\ThirdParty\CoreShop\OGExtractor:
         tags:
-            - {name: seo.meta_data.extractor, identifier: coreshop_og_tags, priority: 10 }
+            - { name: seo.meta_data.extractor, identifier: coreshop_og_tags, priority: 10 }

src/SeoBundle/Resources/config/services/extractors/news.yml → config/services/third_party/news.yaml

@@ -7,4 +7,4 @@ services:
 
     SeoBundle\MetaData\Extractor\ThirdParty\News\EntryMetaExtractor:
         tags:
-            - {name: seo.meta_data.extractor, identifier: news_entry_meta, priority: 10 }
+            - { name: seo.meta_data.extractor, identifier: news_entry_meta, priority: 10 }

config/services/third_party/pimcore_seo.yaml

@@ -0,0 +1,10 @@
+services:
+
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    SeoBundle\EventListener\Admin\SeoDocumentEditorListener:
+        tags:
+            - { name: kernel.event_subscriber }

config/services/third_party/pimcore_xliff.yaml

@@ -0,0 +1,10 @@
+services:
+
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    SeoBundle\EventListener\Admin\XliffListener:
+        tags:
+            - { name: kernel.event_subscriber }

docs/MetaData/Integrator/11_OpenGraphIntegrator.md

@@ -35,7 +35,7 @@ seo:
                         types:
                             - ['my_type', 'my_type']
                         properties:
-                            - ['og:test', 'og:test']
+                            - ['og:test', 'og:test', true] # 3. argument: allow export to xliff translation
                         presets:
                             -   label: 'My Preset'
                                 icon_class: 'pimcore_icon_user'

docs/MetaData/Integrator/12_TwitterCardIntegrator.md

@@ -30,5 +30,5 @@ seo:
                         types:
                             - ['my_type', 'my_type']
                         properties:
-                            - ['twitter:definition', 'twitter:definition']
+                            - ['twitter:definition', 'twitter:definition', true] # 3. argument: allow export to xliff translation
 ```

phpstan.neon

@@ -7,8 +7,8 @@ parameters:
     symfony:
         container_xml_path: %currentWorkingDirectory%/var/cache/test/TestKernelTestDebugContainer.xml
         constant_hassers: false
-    excludes_analyse:
+    excludePaths:
         # as long we don't install the dependencies :(
-        - '*SeoBundle/MetaData/Extractor/ThirdParty/News/EntryMetaExtractor.php'
-        - '*SeoBundle/MetaData/Extractor/ThirdParty/CoreShop/OGExtractor.php'
-        - '*SeoBundle/MetaData/Extractor/ThirdParty/CoreShop/TitleDescriptionExtractor.php'
+        - src/MetaData/Extractor/ThirdParty/News/EntryMetaExtractor.php
+        - src/MetaData/Extractor/ThirdParty/CoreShop/OGExtractor.php
+        - src/MetaData/Extractor/ThirdParty/CoreShop/TitleDescriptionExtractor.php

src/SeoBundle/Resources/public/js/metaData/integrator/propertyIntegrator/item.js → public/js/metaData/integrator/propertyIntegrator/item.js

@@ -64,7 +64,7 @@ Seo.MetaData.Integrator.PropertyIntegratorItem = Class.create({
             user = pimcore.globalmanager.get('user');
 
         propertyTypeStore = new Ext.data.ArrayStore({
-            fields: ['label', 'key'],
+            fields: ['label', 'key', 'xliffExportAware'],
             data: configuration.hasOwnProperty('properties') ? configuration.properties : []
         });