nash-ye/nslug

Yet another unicode slug generator library.

v0.1.1 2016-10-16 22:00 UTC

Requires

• php: >=5.5
• ext-mbstring: *

Requires (Dev)

• phpunit/phpunit: ^5.6

GPL-3.0+

• Nashwan Doaqan

• slug
• unicode

README

Yet another unicode slug generator library.

Usage

use NSlug\SlugGenerator;

$options = [
    'limit'     => null,
    'delimiter' => '-',
    'lowercase' => true,
];

$slugGenerator = new SlugGenerator($options);

// English strings.
echo $slugGenerator->generate('Hello World'); // Prints 'hello-world'.
echo $slugGenerator->generate('Life is too short!'); // Prints 'life-is-too-short'.

// Arabic strings.
echo $slugGenerator->generate('صباح جميل'); // Prints 'صباح-جميل'.
echo $slugGenerator->generate('مساء الخير'); // Prints 'مساء-الخير'.

Options

• limit int|null The characters limit to truncate, default null.
• delimiter string The delimiter, default -.
• lowercase bool Convert to lower-case?, default true.

Installation

The supported way of installing nSlug is via Composer.

$ composer require nash-ye/nslug

Requirements

nSlug requires PHP 5.5+.