{"id":13623813,"url":"https://github.com/voku/portable-ascii","last_synced_at":"2025-05-13T20:08:57.592Z","repository":{"id":35097579,"uuid":"206443539","full_name":"voku/portable-ascii","owner":"voku","description":"🔡 Portable ASCII library - performance optimized (ascii) string functions for PHP.","archived":false,"fork":false,"pushed_at":"2025-04-15T12:30:47.000Z","size":1002,"stargazers_count":558,"open_issues_count":21,"forks_count":35,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-19T19:28:09.715Z","etag":null,"topics":["ascii","hacktoberfest","php","php7","string","translit"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voku.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["voku"],"patreon":"voku","open_collective":"portable-ascii","tidelift":"packagist/voku/portable-ascii","custom":"https://www.paypal.me/moelleken"}},"created_at":"2019-09-05T00:56:52.000Z","updated_at":"2025-03-31T17:37:46.000Z","dependencies_parsed_at":"2023-11-18T01:33:15.339Z","dependency_job_id":"21386871-4b24-49c7-93a8-b6002b49853f","html_url":"https://github.com/voku/portable-ascii","commit_stats":{"total_commits":246,"total_committers":20,"mean_commits":12.3,"dds":0.2682926829268293,"last_synced_commit":"fc540ed0ebcb234a364b022b9fc8143cdce41bde"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fportable-ascii","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fportable-ascii/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fportable-ascii/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fportable-ascii/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voku","download_url":"https://codeload.github.com/voku/portable-ascii/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251183129,"owners_count":21548862,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ascii","hacktoberfest","php","php7","string","translit"],"created_at":"2024-08-01T21:01:35.940Z","updated_at":"2025-04-28T11:57:16.478Z","avatar_url":"https://github.com/voku.png","language":"PHP","funding_links":["https://github.com/sponsors/voku","https://patreon.com/voku","https://opencollective.com/portable-ascii","https://tidelift.com/funding/github/packagist/voku/portable-ascii","https://www.paypal.me/moelleken","https://www.patreon.com/voku","https://paypal.me/moelleken","https://www.patreon.com/voku/posts"],"categories":["目录","Table of Contents","PHP"],"sub_categories":["字符串 Strings","Strings","Library"],"readme":"[//]: # (AUTO-GENERATED BY \"PHP README Helper\": base file -\u003e docs/base.md)\n[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)\n\n[![Build Status](https://github.com/voku/portable-ascii/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/voku/portable-ascii/actions)\n[![Build status](https://ci.appveyor.com/api/projects/status/gnejjnk7qplr7f5t/branch/master?svg=true)](https://ci.appveyor.com/project/voku/portable-ascii/branch/master)\n[![codecov.io](https://codecov.io/github/voku/portable-ascii/coverage.svg?branch=master)](https://codecov.io/github/voku/portable-ascii?branch=master)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/997c9bb10d1c4791967bdf2e42013e8e)](https://www.codacy.com/app/voku/portable-ascii)\n[![Latest Stable Version](https://poser.pugx.org/voku/portable-ascii/v/stable)](https://packagist.org/packages/voku/portable-ascii) \n[![Total Downloads](https://poser.pugx.org/voku/portable-ascii/downloads)](https://packagist.org/packages/voku/portable-ascii)\n[![License](https://poser.pugx.org/voku/portable-ascii/license)](https://packagist.org/packages/voku/portable-ascii)\n[![Donate to this project using Paypal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/moelleken)\n[![Donate to this project using Patreon](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/voku)\n\n# 🔡 Portable ASCII\n\n## Description\n\nIt is written in PHP (PHP 7+) and can work without \"mbstring\", \"iconv\" or any other extra encoding php-extension on your server. \n\nThe benefit of Portable ASCII is that it is easy to use, easy to bundle.\n\nThe project based on ...\n+ Sean M. Burke's work (https://metacpan.org/pod/Text::Unidecode)\n+ Tomaz Solc's work (https://pypi.org/project/Unidecode/)\n+ Portable UTF-8 work (https://github.com/voku/portable-utf8) \n+ Daniel St. Jules's work (https://github.com/danielstjules/Stringy) \n+ Johnny Broadway's work (https://github.com/jbroadway/urlify)\n+ and many cherry-picks from \"github\"-gists and \"Stack Overflow\"-snippets ...\n\n## Index\n\n* [Alternative](#alternative)\n* [Install](#install-portable-ascii-via-composer-require)\n* [Why Portable ASCII?](#why-portable-ascii)\n* [Requirements and Recommendations](#requirements-and-recommendations)\n* [Usage](#usage)\n* [Class methods](#class-methods)\n* [Unit Test](#unit-test)\n* [License and Copyright](#license-and-copyright)\n\n## Alternative\n\nIf you like a more Object Oriented Way to edit strings, then you can take a look at [voku/Stringy](https://github.com/voku/Stringy), it's a fork of \"danielstjules/Stringy\" but it used the \"Portable ASCII\"-Class and some extra methods. \n\n```php\n// Portable ASCII\nuse voku\\helper\\ASCII;\nASCII::to_transliterate('déjà σσς iıii'); // 'deja sss iiii'\n\n// voku/Stringy\nuse Stringy\\Stringy as S;\n$stringy = S::create('déjà σσς iıii');\n$stringy-\u003etoTransliterate();              // 'deja sss iiii'\n```\n\n## Install \"Portable ASCII\" via \"composer require\"\n```shell\ncomposer require voku/portable-ascii\n```\n\n##  Why Portable ASCII?[]()\nI need ASCII char handling in different classes and before I added this functions into \"Portable UTF-8\",\nbut this repo is more modular and portable, because it has no dependencies.\n\n## Requirements and Recommendations\n\n*   No extensions are required to run this library. Portable ASCII only needs PCRE library that is available by default since PHP 4.2.0 and cannot be disabled since PHP 5.3.0. \"\\u\" modifier support in PCRE for ASCII handling is not a must.\n*   PHP 7.0 is the minimum requirement\n*   PHP 8.0 is also supported\n\n## Usage\n\nExample: ASCII::to_ascii()\n```php\n  echo ASCII::to_ascii('�Düsseldorf�', 'de');\n  \n  // will output\n  // Duesseldorf\n\n  echo ASCII::to_ascii('�Düsseldorf�', 'en');\n  \n  // will output\n  // Dusseldorf\n```\n\n# Portable ASCII | API\n\nThe API from the \"ASCII\"-Class is written as small static methods.\n\n\n## Class methods\n\n\u003cp id=\"voku-php-readme-class-methods\"\u003e\u003c/p\u003e\u003ctable\u003e\u003ctr\u003e\u003ctd\u003e\u003ca href=\"#charsarraybool-replace_extra_symbols-array\"\u003echarsArray\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#charsarraywithmultilanguagevaluesbool-replace_extra_symbols-array\"\u003echarsArrayWithMultiLanguageValues\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#charsarraywithonelanguagestring-language-bool-replace_extra_symbols-bool-asorigreplacearray-array\"\u003echarsArrayWithOneLanguage\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#charsarraywithsinglelanguagevaluesbool-replace_extra_symbols-bool-asorigreplacearray-array\"\u003echarsArrayWithSingleLanguageValues\u003c/a\u003e\n\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ca href=\"#cleanstring-str-bool-normalize_whitespace-bool-keep_non_breaking_space-bool-normalize_msword-bool-remove_invisible_characters-string\"\u003eclean\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#getalllanguages-string\"\u003egetAllLanguages\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#is_asciistring-str-bool\"\u003eis_ascii\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#normalize_mswordstring-str-string\"\u003enormalize_msword\u003c/a\u003e\n\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ca href=\"#normalize_whitespacestring-str-bool-keepnonbreakingspace-bool-keepbidiunicodecontrols-bool-normalize_control_characters-string\"\u003enormalize_whitespace\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#remove_invisible_charactersstring-str-bool-url_encoded-string-replacement-bool-keep_basic_control_characters-string\"\u003eremove_invisible_characters\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#to_asciistring-str-string-language-bool-remove_unsupported_chars-bool-replace_extra_symbols-bool-use_transliterate-boolnull-replace_single_chars_only-string\"\u003eto_ascii\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#to_ascii_remapstring-str1-string-str2-string\"\u003eto_ascii_remap\u003c/a\u003e\n\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ca href=\"#to_filenamestring-str-bool-use_transliterate-string-fallback_char-string\"\u003eto_filename\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#to_slugifystring-str-string-separator-string-language-string-replacements-bool-replace_extra_symbols-bool-use_str_to_lower-bool-use_transliterate-string\"\u003eto_slugify\u003c/a\u003e\n\u003c/td\u003e\u003ctd\u003e\u003ca href=\"#to_transliteratestring-str-stringnull-unknown-bool-strict-string\"\u003eto_transliterate\u003c/a\u003e\n\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n\n#### charsArray(bool $replace_extra_symbols): array\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns an replacement array for ASCII methods.\n\nEXAMPLE: \u003ccode\u003e\n$array = ASCII::charsArray();\nvar_dump($array['ru']['б']); // 'b'\n\u003c/code\u003e\n\n**Parameters:**\n- `bool $replace_extra_symbols [optional] \u003cp\u003eAdd some more replacements e.g. \"£\" with \" pound \".\u003c/p\u003e`\n\n**Return:**\n- `array`\n\n--------\n\n#### charsArrayWithMultiLanguageValues(bool $replace_extra_symbols): array\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns an replacement array for ASCII methods with a mix of multiple languages.\n\nEXAMPLE: \u003ccode\u003e\n$array = ASCII::charsArrayWithMultiLanguageValues();\nvar_dump($array['b']); // ['β', 'б', 'ဗ', 'ბ', 'ب']\n\u003c/code\u003e\n\n**Parameters:**\n- `bool $replace_extra_symbols [optional] \u003cp\u003eAdd some more replacements e.g. \"£\" with \" pound \".\u003c/p\u003e`\n\n**Return:**\n- `array \u003cp\u003eAn array of replacements.\u003c/p\u003e`\n\n--------\n\n#### charsArrayWithOneLanguage(string $language, bool $replace_extra_symbols, bool $asOrigReplaceArray): array\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns an replacement array for ASCII methods with one language.\n\nFor example, German will map 'ä' to 'ae', while other languages\nwill simply return e.g. 'a'.\n\nEXAMPLE: \u003ccode\u003e\n$array = ASCII::charsArrayWithOneLanguage('ru');\n$tmpKey = \\array_search('yo', $array['replace']);\necho $array['orig'][$tmpKey]; // 'ё'\n\u003c/code\u003e\n\n**Parameters:**\n- `ASCII::* $language [optional] \u003cp\u003eLanguage of the source string e.g.: en, de_at, or de-ch.\n(default is 'en') | ASCII::*_LANGUAGE_CODE\u003c/p\u003e`\n- `bool $replace_extra_symbols [optional] \u003cp\u003eAdd some more replacements e.g. \"£\" with \" pound \".\u003c/p\u003e`\n- `bool $asOrigReplaceArray [optional] \u003cp\u003eTRUE === return {orig: string[], replace: string[]}\narray\u003c/p\u003e`\n\n**Return:**\n- `array \u003cp\u003eAn array of replacements.\u003c/p\u003e`\n\n--------\n\n#### charsArrayWithSingleLanguageValues(bool $replace_extra_symbols, bool $asOrigReplaceArray): array\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns an replacement array for ASCII methods with multiple languages.\n\nEXAMPLE: \u003ccode\u003e\n$array = ASCII::charsArrayWithSingleLanguageValues();\n$tmpKey = \\array_search('hnaik', $array['replace']);\necho $array['orig'][$tmpKey]; // '၌'\n\u003c/code\u003e\n\n**Parameters:**\n- `bool $replace_extra_symbols [optional] \u003cp\u003eAdd some more replacements e.g. \"£\" with \" pound \".\u003c/p\u003e`\n- `bool $asOrigReplaceArray [optional] \u003cp\u003eTRUE === return {orig: string[], replace: string[]}\narray\u003c/p\u003e`\n\n**Return:**\n- `array \u003cp\u003eAn array of replacements.\u003c/p\u003e`\n\n--------\n\n#### clean(string $str, bool $normalize_whitespace, bool $keep_non_breaking_space, bool $normalize_msword, bool $remove_invisible_characters): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nAccepts a string and removes all non-UTF-8 characters from it + extras if needed.\n\n**Parameters:**\n- `string $str \u003cp\u003eThe string to be sanitized.\u003c/p\u003e`\n- `bool $normalize_whitespace [optional] \u003cp\u003eSet to true, if you need to normalize the\nwhitespace.\u003c/p\u003e`\n- `bool $keep_non_breaking_space [optional] \u003cp\u003eSet to true, to keep non-breaking-spaces, in\ncombination with\n$normalize_whitespace\u003c/p\u003e`\n- `bool $normalize_msword [optional] \u003cp\u003eSet to true, if you need to normalize MS Word chars\ne.g.: \"…\"\n=\u003e \"...\"\u003c/p\u003e`\n- `bool $remove_invisible_characters [optional] \u003cp\u003eSet to false, if you not want to remove invisible\ncharacters e.g.: \"\\0\"\u003c/p\u003e`\n\n**Return:**\n- `string \u003cp\u003eA clean UTF-8 string.\u003c/p\u003e`\n\n--------\n\n#### getAllLanguages(): string[]\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nGet all languages from the constants \"ASCII::.*LANGUAGE_CODE\".\n\n**Parameters:**\n__nothing__\n\n**Return:**\n- `string[]`\n\n--------\n\n#### is_ascii(string $str): bool\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nChecks if a string is 7 bit ASCII.\n\nEXAMPLE: \u003ccode\u003e\nASCII::is_ascii('白'); // false\n\u003c/code\u003e\n\n**Parameters:**\n- `string $str \u003cp\u003eThe string to check.\u003c/p\u003e`\n\n**Return:**\n- `bool \u003cp\u003e\n\u003cstrong\u003etrue\u003c/strong\u003e if it is ASCII\u003cbr\u003e\n\u003cstrong\u003efalse\u003c/strong\u003e otherwise\n\u003c/p\u003e`\n\n--------\n\n#### normalize_msword(string $str): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns a string with smart quotes, ellipsis characters, and dashes from\nWindows-1252 (commonly used in Word documents) replaced by their ASCII\nequivalents.\n\nEXAMPLE: \u003ccode\u003e\nASCII::normalize_msword('„Abcdef…”'); // '\"Abcdef...\"'\n\u003c/code\u003e\n\n**Parameters:**\n- `string $str \u003cp\u003eThe string to be normalized.\u003c/p\u003e`\n\n**Return:**\n- `string \u003cp\u003eA string with normalized characters for commonly used chars in Word documents.\u003c/p\u003e`\n\n--------\n\n#### normalize_whitespace(string $str, bool $keepNonBreakingSpace, bool $keepBidiUnicodeControls, bool $normalize_control_characters): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nNormalize the whitespace.\n\nEXAMPLE: \u003ccode\u003e\nASCII::normalize_whitespace(\"abc-\\xc2\\xa0-öäü-\\xe2\\x80\\xaf-\\xE2\\x80\\xAC\", true); // \"abc-\\xc2\\xa0-öäü- -\"\n\u003c/code\u003e\n\n**Parameters:**\n- `string $str \u003cp\u003eThe string to be normalized.\u003c/p\u003e`\n- `bool $keepNonBreakingSpace [optional] \u003cp\u003eSet to true, to keep non-breaking-spaces.\u003c/p\u003e`\n- `bool $keepBidiUnicodeControls [optional] \u003cp\u003eSet to true, to keep non-printable (for the web)\nbidirectional text chars.\u003c/p\u003e`\n- `bool $normalize_control_characters [optional] \u003cp\u003eSet to true, to convert e.g. LINE-, PARAGRAPH-SEPARATOR with \"\\n\" and LINE TABULATION with \"\\t\".\u003c/p\u003e`\n\n**Return:**\n- `string \u003cp\u003eA string with normalized whitespace.\u003c/p\u003e`\n\n--------\n\n#### remove_invisible_characters(string $str, bool $url_encoded, string $replacement, bool $keep_basic_control_characters): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nRemove invisible characters from a string.\n\ne.g.: This prevents sandwiching null characters between ascii characters, like Java\\0script.\n\ncopy\u0026past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php\n\n**Parameters:**\n- `string $str`\n- `bool $url_encoded`\n- `string $replacement`\n- `bool $keep_basic_control_characters`\n\n**Return:**\n- `string`\n\n--------\n\n#### to_ascii(string $str, string $language, bool $remove_unsupported_chars, bool $replace_extra_symbols, bool $use_transliterate, bool|null $replace_single_chars_only): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns an ASCII version of the string. A set of non-ASCII characters are\nreplaced with their closest ASCII counterparts, and the rest are removed\nby default. The language or locale of the source string can be supplied\nfor language-specific transliteration in any of the following formats:\nen, en_GB, or en-GB. For example, passing \"de\" results in \"äöü\" mapping\nto \"aeoeue\" rather than \"aou\" as in other languages.\n\nEXAMPLE: \u003ccode\u003e\nASCII::to_ascii('�Düsseldorf�', 'en'); // Dusseldorf\n\u003c/code\u003e\n\n**Parameters:**\n- `string $str \u003cp\u003eThe input string.\u003c/p\u003e`\n- `ASCII::* $language [optional] \u003cp\u003eLanguage of the source string.\n(default is 'en') | ASCII::*_LANGUAGE_CODE\u003c/p\u003e`\n- `bool $remove_unsupported_chars [optional] \u003cp\u003eWhether or not to remove the\nunsupported characters.\u003c/p\u003e`\n- `bool $replace_extra_symbols [optional]  \u003cp\u003eAdd some more replacements e.g. \"£\" with \" pound\n\".\u003c/p\u003e`\n- `bool $use_transliterate [optional]  \u003cp\u003eUse ASCII::to_transliterate() for unknown chars.\u003c/p\u003e`\n- `bool|null $replace_single_chars_only [optional]  \u003cp\u003eSingle char replacement is better for the\nperformance, but some languages need to replace more then one char\nat the same time. | NULL === auto-setting, depended on the\nlanguage\u003c/p\u003e`\n\n**Return:**\n- `string \u003cp\u003eA string that contains only ASCII characters.\u003c/p\u003e`\n\n--------\n\n#### to_ascii_remap(string $str1, string $str2): string[]\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nWARNING: This method will return broken characters and is only for special cases.\n\nConvert two UTF-8 encoded string to a single-byte strings suitable for\nfunctions that need the same string length after the conversion.\n\nThe function simply uses (and updates) a tailored dynamic encoding\n(in/out map parameter) where non-ascii characters are remapped to\nthe range [128-255] in order of appearance.\n\n**Parameters:**\n- `string $str1`\n- `string $str2`\n\n**Return:**\n- `string[]`\n\n--------\n\n#### to_filename(string $str, bool $use_transliterate, string $fallback_char): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nConvert given string to safe filename (and keep string case).\n\nEXAMPLE: \u003ccode\u003e\nASCII::to_filename('שדגשדג.png', true)); // 'shdgshdg.png'\n\u003c/code\u003e\n\n**Parameters:**\n- `string $str`\n- `bool $use_transliterate \u003cp\u003eASCII::to_transliterate() is used by default - unsafe characters are\nsimply replaced with hyphen otherwise.\u003c/p\u003e`\n- `string $fallback_char`\n\n**Return:**\n- `string \u003cp\u003eA string that contains only safe characters for a filename.\u003c/p\u003e`\n\n--------\n\n#### to_slugify(string $str, string $separator, string $language, string[] $replacements, bool $replace_extra_symbols, bool $use_str_to_lower, bool $use_transliterate): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nConverts the string into an URL slug. This includes replacing non-ASCII\ncharacters with their closest ASCII equivalents, removing remaining\nnon-ASCII and non-alphanumeric characters, and replacing whitespace with\n$separator. The separator defaults to a single dash, and the string\nis also converted to lowercase. The language of the source string can\nalso be supplied for language-specific transliteration.\n\n**Parameters:**\n- `string $str`\n- `string $separator [optional] \u003cp\u003eThe string used to replace whitespace.\u003c/p\u003e`\n- `ASCII::* $language [optional] \u003cp\u003eLanguage of the source string.\n(default is 'en') | ASCII::*_LANGUAGE_CODE\u003c/p\u003e`\n- `array\u003cstring, string\u003e $replacements [optional] \u003cp\u003eA map of replaceable strings.\u003c/p\u003e`\n- `bool $replace_extra_symbols [optional]  \u003cp\u003eAdd some more replacements e.g. \"£\" with \"\npound \".\u003c/p\u003e`\n- `bool $use_str_to_lower [optional] \u003cp\u003eUse \"string to lower\" for the input.\u003c/p\u003e`\n- `bool $use_transliterate [optional]  \u003cp\u003eUse ASCII::to_transliterate() for unknown\nchars.\u003c/p\u003e`\n\n**Return:**\n- `string \u003cp\u003eA string that has been converted to an URL slug.\u003c/p\u003e`\n\n--------\n\n#### to_transliterate(string $str, string|null $unknown, bool $strict): string\n\u003ca href=\"#voku-php-readme-class-methods\"\u003e↑\u003c/a\u003e\nReturns an ASCII version of the string. A set of non-ASCII characters are\nreplaced with their closest ASCII counterparts, and the rest are removed\nunless instructed otherwise.\n\nEXAMPLE: \u003ccode\u003e\nASCII::to_transliterate('déjà σσς iıii'); // 'deja sss iiii'\n\u003c/code\u003e\n\n**Parameters:**\n- `string $str \u003cp\u003eThe input string.\u003c/p\u003e`\n- `string|null $unknown [optional] \u003cp\u003eCharacter use if character unknown. (default is '?')\nBut you can also use NULL to keep the unknown chars.\u003c/p\u003e`\n- `bool $strict [optional] \u003cp\u003eUse \"transliterator_transliterate()\" from PHP-Intl`\n\n**Return:**\n- `string \u003cp\u003eA String that contains only ASCII characters.\u003c/p\u003e`\n\n--------\n\n\n\n## Unit Test\n\n1) [Composer](https://getcomposer.org) is a prerequisite for running the tests.\n\n```\ncomposer install\n```\n\n2) The tests can be executed by running this command from the root directory:\n\n```bash\n./vendor/bin/phpunit\n```\n\n### Support\n\nFor support and donations please visit [Github](https://github.com/voku/portable-ascii/) | [Issues](https://github.com/voku/portable-ascii/issues) | [PayPal](https://paypal.me/moelleken) | [Patreon](https://www.patreon.com/voku).\n\nFor status updates and release announcements please visit [Releases](https://github.com/voku/portable-ascii/releases) | [Twitter](https://twitter.com/suckup_de) | [Patreon](https://www.patreon.com/voku/posts).\n\nFor professional support please contact [me](https://about.me/voku).\n\n### Thanks\n\n- Thanks to [GitHub](https://github.com) (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.\n- Thanks to [IntelliJ](https://www.jetbrains.com) as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!\n- Thanks to [Travis CI](https://travis-ci.com/) for being the most awesome, easiest continous integration tool out there!\n- Thanks to [StyleCI](https://styleci.io/) for the simple but powerful code style check.\n- Thanks to [PHPStan](https://github.com/phpstan/phpstan) \u0026\u0026 [Psalm](https://github.com/vimeo/psalm) for really great Static analysis tools and for discover bugs in the code!\n\n### License and Copyright\n\nReleased under the MIT License - see `LICENSE.txt` for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoku%2Fportable-ascii","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoku%2Fportable-ascii","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoku%2Fportable-ascii/lists"}