xety/cake3-sluggable

A simple Cake3 plugin to slug fields and find records by slug.

Cake3 Sluggable

A simple Cake3 plugin to slug fields and find records by slug., _(*1)

, _(*2)

Requirements

• CakePHP 3.X

Installation

Run : composer require xety/cake3-sluggable:1.* Or add it in your composer.json: ``` php "require": { "xety/cake3-sluggable": "1.*" },, _(*3)

## Usage
In your `config/bootstrap.php` add :
``` php
Plugin::load('Xety/Cake3Sluggable');

In your model initialize(): ``` php $this->addBehavior('Xety/Cake3Sluggable.Sluggable');, _(*4)

To use the custom finder :
``` php
$this->Users
    ->find('slug', [
        'slug' => 'your-slug-here',
        'slugField' => 'Users.slug'
    ]);

Configuration

• field

  Default : title, _(*5)

  The field to slug : php $this->addBehavior('Xety/Cake3Sluggable.Sluggable', [ 'field' => 'username' ] );, _(*6)

• slug

  Default : slug, _(*7)

  The slug field name in your database : php $this->addBehavior('Xety/Cake3Sluggable.Sluggable', [ 'field' => 'username', 'slug' => 'slug_username' ] );, _(*8)

• replacement

  Default : -, _(*9)

  The replacement characters used to replace space etc : php $this->addBehavior('Xety/Cake3Sluggable.Sluggable', [ 'replacement' => '_' ] );, _(*10)

Contribute

Follow this guide to contribute, _(*11)