jbroadway / urlify
A fast PHP slug generator and transliteration library that converts non-ascii characters for use in URLs.
Installs: 4 914 244
Dependents: 61
Suggesters: 0
Security: 0
Stars: 673
Watchers: 34
Forks: 79
Open Issues: 6
Requires
- php: >=7.2
- voku/portable-ascii: ^2.0
- voku/stop-words: ^2.0
Requires (Dev)
- phpunit/phpunit: ^8.5
- 1.2.4-stable
- 1.2.3-stable
- 1.2.2-stable
- 1.2.1-stable
- 1.2.0-stable
- 1.1.3-stable
- 1.1.2-stable
- 1.1.1-stable
- 1.1.0-stable
- dev-master / 1.0.x-dev
- 1.0.9-stable
- 1.0.8-stable
- 1.0.7-stable
- 1.0.6-stable
- 1.0.5-stable
- 1.0.4-stable
- 1.0.3-stable
- 1.0.2-stable
- 1.0.1-stable
- 1.0.0-stable
- dev-voku-portable-ascii-2.0
- dev-php74-travis-ci
- dev-php-7.4-testing
This package is auto-updated.
Last update: 2024-11-05 17:22:20 UTC
README
A fast PHP slug generator and transliteration library, started as a PHP port of URLify.js from the Django project.
Handles symbols from latin languages, Arabic, Azerbaijani, Bulgarian, Burmese, Croatian, Czech, Danish, Esperanto,
Estonian, Finnish, French, Switzerland (French), Austrian (French), Georgian, German, Switzerland (German),
Austrian (German), Greek, Hindi, Kazakh, Latvian, Lithuanian, Norwegian, Persian, Polish, Romanian, Russian, Swedish,
Serbian, Slovak, Turkish, Ukrainian and Vietnamese, and many other via ASCII::to_transliterate()
.
Symbols it cannot transliterate it can omit or replace with a specified character.
Installation
Install the latest version with:
$ composer require jbroadway/urlify
Usage
First, include Composer's autoloader:
require_once 'vendor/autoload.php';
To generate slugs for URLs:
<?php echo URLify::slug (' J\'étudie le français '); // "jetudie-le-francais" echo URLify::slug ('Lo siento, no hablo español.'); // "lo-siento-no-hablo-espanol"
To generate slugs for file names:
<?php echo URLify::filter ('фото.jpg', 60, "", true); // "foto.jpg"
To simply transliterate characters:
<?php echo URLify::downcode ('J\'étudie le français'); // "J'etudie le francais" echo URLify::downcode ('Lo siento, no hablo español.'); // "Lo siento, no hablo espanol." /* Or use transliterate() alias: */ echo URLify::transliterate ('Lo siento, no hablo español.'); // "Lo siento, no hablo espanol."
To extend the character list:
<?php URLify::add_chars ([ '¿' => '?', '®' => '(r)', '¼' => '1/4', '½' => '1/2', '¾' => '3/4', '¶' => 'P' ]); echo URLify::downcode ('¿ ® ¼ ¼ ¾ ¶'); // "? (r) 1/2 1/2 3/4 P"
To extend the list of words to remove:
<?php URLify::remove_words (['remove', 'these', 'too']);
To prioritize a certain language map:
<?php echo 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 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.