Document slugify

Author: janbuecker

exampleplugins/5.2/SwagCustomSlugConfig/Resources/services.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="shopware.slug.config" type="collection">
+            <parameter key="regexp">/([^A-Za-z0-9\.&amp;]|-)+/</parameter>
+            <parameter key="lowercase">false</parameter>
+        </parameter>
+    </parameters>
+</container>

exampleplugins/5.2/SwagCustomSlugConfig/SwagCustomSlugConfig.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SwagCustomSlugConfig;
+
+use Shopware\Components\Plugin;
+
+class SwagCustomSlugConfig extends Plugin
+{
+}

exampleplugins/5.2/SwagCustomSlugService/Resources/services.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+
+    <services>
+        <service id="SwagCustomSlugService.slug"
+                 class="SwagCustomSlugService\SlugService"
+                 decorates="shopware.slug">
+            <argument type="service" id="SwagCustomSlugService.slug.inner" />
+        </service>
+    </services>
+</container>

exampleplugins/5.2/SwagCustomSlugService/SlugService.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace SwagCustomSlugService;
+
+use Shopware\Components\Slug\SlugInterface;
+
+class SlugService implements SlugInterface
+{
+    /**
+     * @var SlugInterface
+     */
+    private $coreSlugService;
+
+    /**
+     * @param SlugInterface $core
+     */
+    public function __construct(SlugInterface $core)
+    {
+        $this->coreSlugService = $core;
+    }
+
+    /**
+     * Return a URL safe version of a string.
+     *
+     * @param string $string
+     * @param string|null $separator
+     *
+     * @return string
+     */
+    public function slugify($string, $separator = null)
+    {
+        $string = html_entity_decode($string);
+
+        return $this->coreSlugService->slugify($string, $separator);
+    }
+}

exampleplugins/5.2/SwagCustomSlugService/SwagCustomSlugService.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace SwagCustomSlugService;
+
+use Shopware\Components\Plugin;
+
+class SwagCustomSlugService extends Plugin
+{
+}

source/developers-guide/plugin-slugify/index.md

@@ -0,0 +1,34 @@
+---
+layout: default
+title: Create custom url slugger 
+github_link: developers-guide/plugin-slugify/index.md
+indexed: true
+group: Developer Guides
+subgroup: Tutorials
+menu_title: Create custom url slugger
+menu_order: 35
+shopware_version: 5.2.5
+---
+
+From Shopware 5.2.5 we implemented the slugify-Framework. Slugify rewrites special characters like ñ, Ñ, ¿, é or Ó to n,n,-,e or o. If you named your article "tomàtiga de ramellet" the URL will be created like this "tomatiga-de-ramellet". Please note the slash will not be rewritten. That means that the article name „tomàtiga de ramellet / ecológica“ will be rewritten to "tomatiga-de-ramellet/ecologica".
+
+## Configure slugify ruleset
+
+By default, the slugify framework is defined with its default settings.
+
+As part of the implementation in Shopware, you can overwrite the parameters in the dependency injection container by creating a `Resources/services.xml` file in your plugin.
+
+```xml
+<parameter key="shopware.slug.config" type="collection">
+    <parameter key="regexp">/([^A-Za-z0-9\.]|-)+/</parameter>
+    <parameter key="lowercase">false</parameter>
+</parameter>
+```
+
+You can download an example plugin with this changes <a href="{{ site.url }}/exampleplugins/SwagCustomSlugConfig.zip">here</a>.
+
+## Decorate the slugify service
+
+Another approach could be to decorate the existing service and implement your own logic using the `Shopware\Components\Slug\SlugInterface`.
+
+You can download an example plugin with this changes <a href="{{ site.url }}/exampleplugins/SwagCustomSlugService.zip">here</a>.