php-extended/php-slugifier-object

A simple implementation of the php-slugifier-interface library

4.4.1 2022-06-10 13:18 UTC

README

This library contains a slugifier that does ascii transliterations of unicode text. This library is inspired by martinml's implementation of transliterator and the original python implementation.

coverage build status

Installation

The installation of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"php-extended/php-slugifier-object": "^4",
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Basic Usage

This library may be used the following way :


use PhpExtended\Slugifier\SlugifierFactory;

$factory = new SlugifierFactory();
$slugifier = $factory->createSlugifier();
/* @var $slugifier \PhpExtended\Slugifier\SlugifierInterface */

There are different types of slugifiers available in this library :

  • The AsciiCutSlugifier removes all characters from the input string that are not digits or letters.
  • The LowercaseSlugifier transforms the input string to lowercase
  • The UppercaseSlugifier transforms the input string to uppercase
  • The NoopSlugifier returns the input string untouched
  • The SlugifierChain is made to chain multiple slugifiers to have a final slugified string. Not that the order matters.
  • The AsciiTransliteratorSlugifier transliterates the utf8 characters

License

Original character transliteration tables:

Copyright 2001, Sean M. Burke sburke@cpan.org, all rights reserved.

Modifications on the tables and the code (/src) is:

MIT (See license file).