j0an/urlify

Port to Laravel4 of jbroadway's PHP port of URLify.js from the Django project. Transliterates non-ascii characters for use in URLs.

dev-master 2017-04-06 19:35 UTC

This package is not auto-updated.

Last update: 2024-04-19 18:05:39 UTC


README

A PHP port of URLify.js from the Django project. Handles symbols from Latin languages, Czech, Greek, Latvian, Lithuanian, Polish, Romanian, Russian, Turkish and Ukrainian. Symbols it cannot transliterate it will simply omit.

Install:

  • Add "require": { "j0an/urlify": "dev-master" } to composer.json

  • Run composer update

  • Add to app/config at the bottom of Providers:

'j0an\Urlify\UrlifyServiceProvider'

Usage:

To generate slugs for URLs:

<?php

echo j0an\Urlify::filter (' J\'étudie le français ');
// "jetudie-le-francais"

echo j0an\Urlify::filter ('Lo siento, no hablo español.');
// "lo-siento-no-hablo-espanol"

?>

To simply transliterate characters:

<?php

echo j0an\Urlify::downcode ('J\'étudie le français');
// "J'etudie le francais"

echo j0an\Urlify::downcode ('Lo siento, no hablo español.');
// "Lo siento, no hablo espanol."

/* Or use transliterate() alias: */

echo j0an\Urlify::transliterate ('Lo siento, no hablo español.');
// "Lo siento, no hablo espanol."

?>

To extend the character list:

<?php

j0an\Urlify::add_chars (array (
	'¿' => '?', '®' => '(r)', '¼' => '1/4',
	'¼' => '1/2', '¾' => '3/4', '¶' => 'P'
));

echo j0an\Urlify::downcode ('¿ ® ¼ ¼ ¾ ¶');
// "? (r) 1/2 1/2 3/4 P"

?>

To extend the list of words to remove:

<?php

j0an\Urlify::remove_words (array ('remove', 'these', 'too'));

?>

To priorize a certain language map:

<?php

echo j0an\Urlify::filter (' Ägypten und Österreich besitzen wie üblich ein Übermaß an ähnlich öligen Attachés ',60,"de");
// "aegypten-und-oesterreich-besitzen-wie-ueblich-ein-uebermass-aehnlich-oeligen-attaches"

echo j0an\Urlify::filter ('Cağaloğlu, çalıştığı, müjde, lazım, mahkûm',60,"tr");
// "cagaloglu-calistigi-mujde-lazim-mahkum"

?>

Please note that the "ü" is transliterated to "ue" in the first case, whereas it results in a simple "u" in the latter.