Merge pull request #19 from UseMuffin/cake-slugger

Cake slugger

Author: jadb

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.4
   - 5.5
   - 5.6
   - 7.0

README.md

@@ -9,14 +9,20 @@ Slugging for CakePHP 3.x
 
 ## Requirements
 
-- CakePHP 3.0+
+- CakePHP 3.2.7+ (for lower CakePHP versions use plugin version 1.0.*)
 
 ## Installation
 
 Using [Composer][composer]:
 
 ```bash
-composer require muffin/slug:~1.0
+composer require muffin/slug
+```
+
+or if your CakePHP is less than 3.2.7 use
+
+```bash
+composer require muffin/slug:1.0.*
 ```
 
 To make your application load the plugin either run:
@@ -38,10 +44,10 @@ To enable slugging add the behavior to your table classes in the
 ```php
 public function initialize(array $config)
 {
-  //etc
-  $this->addBehavior('Muffin/Slug.Slug', [
-    // Optionally define your custom options here (see Configuration)
-  ]);
+    //etc
+    $this->addBehavior('Muffin/Slug.Slug', [
+        // Optionally define your custom options here (see Configuration)
+    ]);
 }
 ```
 
@@ -77,9 +83,32 @@ Slug comes with the following configuration options:
 - `implementedEvents`: events this behavior listens to.
 - `implementedFinders`: custom finders implemented by this behavior.
 - `implementedMethods`: mixin methods directly accessible from the table.
-- `onUpdate`: Boolean indicating whether slug should be updated when updating 
+- `onUpdate`: Boolean indicating whether slug should be updated when updating
   record, defaults to `false`.
 
+## Sluggers
+
+The plugin contains two sluggers:
+
+### CakeSlugger
+
+The `CakeSlugger` uses `\Cake\Utility\Text::slug()` to generate slugs. In the
+behavior config you can set the `slugger` key as shown below to pass options to
+the `$options` arguments of `Text::slug()`.
+
+```php
+'slugger' => [
+    'className' => 'Muffin\Slug\Slugger\CakeSlugger',
+    'transliteratorId' => '<A valid ICU Transliterator ID here>'
+]
+```
+
+### ConcurSlugger
+
+The `ConcurSlugger` uses [concur/slugify](https://github.com/cocur/slugify) to generate slugs.
+You can use config array similar to the one shown above to pass options to
+`Cocur\Slugify\Slugify`'s constructor.
+
 ## Patches & Features
 
 * Fork
@@ -100,10 +129,6 @@ ln -s ../../contrib/pre-commit .git/hooks/.
 
 http://github.com/usemuffin/slug/issues
 
-## Credits
-
-This was originally inspired by @dereuromark's [`SluggedBehavior`](https://github.com/dereuromark/cakephp-tools/blob/cake3/src/Model/Behavior/SluggedBehavior.php).
-
 ## License
 
 Copyright (c) 2015, [Use Muffin][muffin] and licensed under [The MIT License][mit].

composer.json

@@ -31,10 +31,10 @@
         "source": "https://github.com/usemuffin/slug"
     },
     "require": {
-        "cakephp/orm": "~3.1"
+        "cakephp/orm": "^3.2.7"
     },
     "require-dev": {
-        "cakephp/cakephp": "~3.1",
+        "cakephp/cakephp": "^3.2.7",
         "phpunit/phpunit": "4.1.*",
         "cocur/slugify": "^1.2"
     },

src/Slugger/CakeSlugger.php

@@ -1,20 +1,21 @@
 <?php
 namespace Muffin\Slug\Slugger;
 
-use Cake\Utility\Inflector;
+use Cake\Utility\Text;
 use Muffin\Slug\SluggerInterface;
 
 /**
- * CakePHP slugger (using `Inflector::slug()`).
+ * CakePHP slugger.
  */
 class CakeSlugger implements SluggerInterface
 {
 
     /**
-     * Config options.
+     * Config options. You can set any valid option which Text::slug() takes
+     * besides the one listed below:
      *
      * - `lowercase` - Boolean indication whether slug should be lowercased.
-     *   Default to true.
+     *   Defaults to true.
      *
      * @var array
      */
@@ -31,10 +32,12 @@ class CakeSlugger implements SluggerInterface
      */
     public function slug($string, $replacement = '-')
     {
-        $string = Inflector::slug($string, $replacement);
+        $config = $this->config;
+        $config['replacement'] = $replacement;
+        $string = Text::slug($string, $config);
 
-        if ($this->config['lowercase']) {
-            return strtolower($string);
+        if ($config['lowercase']) {
+            return mb_strtolower($string);
         }
 
         return $string;