malenki / slug
Simple class to create slug.
Requires
- php: >=5.3.0
- ext-intl: *
Suggests
- ext-mbstring: To convert to lowercase non ASCII characters.
This package is not auto-updated.
Last update: 2024-10-26 16:10:25 UTC
README
Slug creator, with history and language transliteration.
How to install it
You can clone this repository or use composer:
{ "require": { "malenki/slug": "dev-master", } }
Requirements
You must have Intl PHP extension and mbstring PHP extension.
How to use it
Basic usage
Very simple:
use \Malenki\Slug; $s = new Slug('Some string!'); echo $s->render(); //or echo $s; // toString available, give "some-string"
Add custom rules
You can add your own rules to replace some chars:
use \Malenki\Slug; $s = new Slug('One example string, again!'); $s->rule('!', '-wouah'); echo $s; // "one-example-string-again-wouah"
You can define void slug object to use many string later, usefull if you define rules, to use them again and again:
use \Malenki\Slug; $s = new Slug(); $s->rule('!', '-wouah')->rule('?', '-huh'); $s->v('Genius!'); echo $s; // "genius-wouah" $s->v('Genius?'); echo $s; // "genius-huh"
History
By default, Slug use history into running script context, if a generated slug is already present, then add number with increment to it:
use \Malenki\Slug; $s = new Slug('one-string'); echo $s; // "one-string" $s = new Slug('one-string'); echo $s; // "one-string-2" $s = new Slug('one-string'); echo $s; // "one-string-3"
But you can disable this behaviour:
use \Malenki\Slug; $s = new Slug('one-string'); echo $s->noHistory(); // "one-string" $s = new Slug('one-string'); echo $s->noHistory(); // "one-string" $s = new Slug('one-string'); echo $s->noHistory(); // "one-string" // or $s = new Slug(); echo $s->noHistory()->v('one-string'); // "one-string" echo $s->noHistory()->v('one-string'); // "one-string" echo $s->noHistory()->v('one-string'); // "one-string"
You can use predefined history of slug too, usefull if you have a lot of them in DB for example:
$s = new Slug(); Slug::history(array('one-string', 'another-one')); echo $s->v('one-string'); // "one-string-2"
Non-ASCII characters
Use other language than english is possible too:
// some french $s = new Slug('C’est rigolo d’écrire en français !'); echo $s; // "c-est-rigolo-d-ecrire-en-francais" // some greek $s = new Slug('Τα ελληνικά σου είναι καλύτερα απο τα Γαλλικά μου!'); echo $s; // "ta-ellenika-sou-einai-kalytera-apo-ta-gallika-mou"
So, enjoy!