Merge pull request #43 from aarongerig/1.x

solverat · web-flow · commit b1611c81f043 · 2022-11-23T09:16:37.000+01:00
[HtmlTagIntegrator] Add presets (V1)
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -8,6 +8,10 @@ Just click the "update" button or execute the migration command to finish the bu
 
 ***
 
+#### Version 1.2
+- Support Pimcore 6.9 only
+- Add presets to HTML tag integrator [#43](https://github.com/dachcom-digital/pimcore-seo/pull/43)
+
 #### Update from Version 1.1.0 to Version 1.1.1
 - **[ENHANCEMENT]** Improve Dependency Check [#20](https://github.com/dachcom-digital/pimcore-seo/issues/20)
 
diff --git a/composer.json b/composer.json
@@ -35,7 +35,7 @@
     },
     "require": {
         "google/apiclient": "^2.0",
-        "pimcore/pimcore": "^6.0",
+        "pimcore/pimcore": "^6.9",
         "doctrine/orm": "^2.7"
     },
     "require-dev": {
diff --git a/docs/MetaData/Integrator/14_HtmlTagIntegrator.md b/docs/MetaData/Integrator/14_HtmlTagIntegrator.md
@@ -14,3 +14,34 @@ seo:
             enabled_integrator:
                 -   integrator_name: html_tag
 ```
+
+## Extended Configuration
+
+```yaml
+seo:
+    meta_data_configuration:
+        meta_data_integrator:
+            enabled_integrator:
+                -   integrator_name: html_tag
+                    integrator_config:
+                        presets_only_mode: false
+                        presets:
+                            -
+                                label: 'Robots No-Index'
+                                value: '<meta name="robots" content="noindex, nofollow">'
+                                icon_class: 'pimcore_icon_stop'
+                            -   
+                                label: 'Secret Meta-Link'
+                                value: '<meta name="secret" content="secret-thing">'
+```
+
+### presets
+If defined, the user is able to add predefined presets. They can only be added and not edited!
+
+![image](https://user-images.githubusercontent.com/700119/202385523-b748a0d3-56c3-4403-980f-53c60c2b45e8.png)
+
+![image](https://user-images.githubusercontent.com/700119/202278570-51d1ed18-e323-4704-b0d7-09649fca2281.png)
+
+### presets_only_mode
+If set to `true`, the user is not able to add custom tags but only presets:
+![image](https://user-images.githubusercontent.com/700119/202385300-61f5d884-8d4f-4353-8c0f-5cc6c79a7b7c.png)
diff --git a/src/SeoBundle/MetaData/Integrator/HtmlTagIntegrator.php b/src/SeoBundle/MetaData/Integrator/HtmlTagIntegrator.php
@@ -20,7 +20,9 @@ public function getBackendConfiguration($element)
         return [
             'hasLivePreview'       => false,
             'livePreviewTemplates' => [],
-            'useLocalizedFields'   => false
+            'useLocalizedFields'   => false,
+            'presets'              => $this->configuration['presets'],
+            'presets_only_mode'    => $this->configuration['presets_only_mode'],
         ];
     }
 
@@ -102,6 +104,13 @@ public function setConfiguration(array $configuration)
      */
     public static function configureOptions(OptionsResolver $resolver)
     {
-        // no options here.
+        $resolver->setDefaults([
+            'presets_only_mode' => false,
+            'presets'           => [],
+        ]);
+
+        $resolver->setRequired(['presets_only_mode']);
+        $resolver->setAllowedTypes('presets_only_mode', ['bool']);
+        $resolver->setAllowedTypes('presets', ['array']);
     }
 }
diff --git a/src/SeoBundle/MetaData/MetaDataProvider.php b/src/SeoBundle/MetaData/MetaDataProvider.php
@@ -2,8 +2,8 @@
 
 namespace SeoBundle\MetaData;
 
-use Pimcore\Templating\Helper\HeadMeta;
-use Pimcore\Templating\Helper\HeadTitle;
+use Pimcore\Twig\Extension\Templating\HeadMeta;
+use Pimcore\Twig\Extension\Templating\HeadTitle;
 use SeoBundle\MetaData\Extractor\ExtractorInterface;
 use SeoBundle\Middleware\MiddlewareDispatcherInterface;
 use SeoBundle\Registry\MetaDataExtractorRegistryInterface;
diff --git a/src/SeoBundle/Resources/public/js/metaData/integrator/htmlTagIntegrator.js b/src/SeoBundle/Resources/public/js/metaData/integrator/htmlTagIntegrator.js
@@ -2,6 +2,7 @@ pimcore.registerNS('Seo.MetaData.Integrator.HtmlTagIntegrator');
 Seo.MetaData.Integrator.HtmlTagIntegrator = Class.create(Seo.MetaData.Integrator.AbstractIntegrator, {
 
     fieldSetTitle: t('seo_bundle.integrator.html.title') + ' (&lt;meta .../&gt; &lt;link .../&gt; ...)',
+    addPresetButtonLabel: t('seo_bundle.integrator.property.add_preset'),
     iconClass: 'seo_integrator_icon_html_tags',
     htmlTagPanel: null,
 
@@ -30,52 +31,109 @@ Seo.MetaData.Integrator.HtmlTagIntegrator = Class.create(Seo.MetaData.Integrator
         }
 
         Ext.Array.each(this.data, function (htmlTagValue) {
-            this.addHtmlTagField(htmlTagValue);
+            var presetData = this.getPresetByValue(htmlTagValue);
+            this.addHtmlTagField(
+                htmlTagValue,
+                presetData !== null,
+                presetData !== null && presetData.hasOwnProperty('label') ? presetData.label : null
+            );
         }.bind(this));
     },
 
     getAddControl: function () {
 
         var items = [],
+            presetMenu = [],
+            configuration = this.getConfiguration(),
+            availablePresets = configuration.hasOwnProperty('presets') ? configuration.presets : [],
+            presetsOnlyMode = configuration.hasOwnProperty('presets_only_mode') ? configuration.presets_only_mode : false,
             user = pimcore.globalmanager.get('user');
 
-        if(user.isAllowed('seo_bundle_add_property') === false) {
+        if (user.isAllowed('seo_bundle_add_property') === false) {
             return [];
         }
 
-        items.push({
-            cls: 'pimcore_block_button_plus',
-            text: t('seo_bundle.integrator.html.add_field'),
-            iconCls: 'pimcore_icon_plus',
-            handler: this.addHtmlTagField.bind(this, null, null)
-        });
+        if (presetsOnlyMode === false) {
+            items.push({
+                cls: 'pimcore_block_button_plus',
+                text: t('seo_bundle.integrator.html.add_field'),
+                iconCls: 'pimcore_icon_plus',
+                handler: this.addHtmlTagField.bind(this, null, null, null)
+            });
+        }
 
-        items.push({
-            xtype: 'container',
-            flex: 1,
-            html: t('seo_bundle.integrator.html.caution_note'),
-            style: {
-                padding: '5px',
-                border: '1px solid #b32d2d',
-                background: '#e8acac',
-                margin: '0 0 10px 0',
-                color: 'black'
-            }
-        });
+        if (availablePresets.length > 0) {
+
+            Ext.Array.each(availablePresets, function (preset) {
+
+                var label = preset.hasOwnProperty('label') ? preset.label : ('Preset ' + index),
+                    icon = preset.hasOwnProperty('icon_class') && preset.icon_class !== null ? preset.icon_class : 'pimcore_icon_brick';
+
+                presetMenu.push({
+                    text: label,
+                    iconCls: icon,
+                    handler: this.addHtmlTagField.bind(this, preset.hasOwnProperty('value') ? preset.value : '#', true, label)
+                });
+
+            }.bind(this));
+
+            items.push({
+                cls: 'pimcore_block_button_plus',
+                text: this.addPresetButtonLabel,
+                iconCls: 'pimcore_icon_objectbricks',
+                menu: presetMenu
+            });
+        }
+
+        if (presetsOnlyMode === false) {
+            items.push({
+                xtype: 'container',
+                flex: 1,
+                html: t('seo_bundle.integrator.html.caution_note'),
+                style: {
+                    padding: '5px',
+                    border: '1px solid #b32d2d',
+                    background: '#e8acac',
+                    margin: '0 0 10px 0',
+                    color: 'black'
+                }
+            });
+        }
 
         return new Ext.Toolbar({
             items: items
         });
     },
 
-    addHtmlTagField: function (fieldValue) {
+    getPresetByValue: function (htmlTagValue) {
+
+        var presetData = null,
+            configuration = this.getConfiguration(),
+            availablePresets = configuration.hasOwnProperty('presets') ? configuration.presets : [];
+
+        if (availablePresets.length === 0) {
+            return null;
+        }
+
+        Ext.Array.each(availablePresets, function (preset) {
+            if (preset.hasOwnProperty('value') && preset.value === htmlTagValue) {
+                presetData = preset;
+                return false;
+            }
+
+        }.bind(this));
+
+        return presetData;
+    },
+
+    addHtmlTagField: function (fieldValue, disabled, tagName) {
 
         var itemFieldContainer,
             user = pimcore.globalmanager.get('user');
 
         itemFieldContainer = new Ext.form.FieldContainer({
             xtype: 'fieldcontainer',
-            width: 700,
+            width: 800,
             layout: 'hbox',
             style: {
                 marginTop: '5px',
@@ -85,10 +143,12 @@ Seo.MetaData.Integrator.HtmlTagIntegrator = Class.create(Seo.MetaData.Integrator
             items: [
                 {
                     xtype: 'textfield',
-                    fieldLabel: t('seo_bundle.integrator.html.tag'),
+                    labelWidth: 170,
+                    fieldLabel: Ext.isString(tagName) ? tagName : t('seo_bundle.integrator.html.tag'),
                     style: 'margin: 0 10px 0 0',
                     name: 'tags',
                     value: fieldValue,
+                    readOnly: disabled === true,
                     flex: 1,
                 },
                 {
@@ -135,4 +195,4 @@ Seo.MetaData.Integrator.HtmlTagIntegrator = Class.create(Seo.MetaData.Integrator
     getValuesForPreview: function () {
         return [];
     }
-});
+});

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@ public function getBackendConfiguration($element)`
`20`	`20`	`return [`
`21`	`21`	`'hasLivePreview' => false,`
`22`	`22`	`'livePreviewTemplates' => [],`
`23`		`- 'useLocalizedFields' => false`
	`23`	`+ 'useLocalizedFields' => false,`
	`24`	`+ 'presets' => $this->configuration['presets'],`
	`25`	`+ 'presets_only_mode' => $this->configuration['presets_only_mode'],`
`24`	`26`	`];`
`25`	`27`	`}`
`26`	`28`
`@@ -102,6 +104,13 @@ public function setConfiguration(array $configuration)`
`102`	`104`	`*/`
`103`	`105`	`public static function configureOptions(OptionsResolver $resolver)`
`104`	`106`	`{`
`105`		`- // no options here.`
	`107`	`+ $resolver->setDefaults([`
	`108`	`+ 'presets_only_mode' => false,`
	`109`	`+ 'presets' => [],`
	`110`	`+ ]);`
	`111`	`+`
	`112`	`+ $resolver->setRequired(['presets_only_mode']);`
	`113`	`+ $resolver->setAllowedTypes('presets_only_mode', ['bool']);`
	`114`	`+ $resolver->setAllowedTypes('presets', ['array']);`
`106`	`115`	`}`
`107`	`116`	`}`