Merge pull request #126 from Laravel-Lang/5.x

Updated documentation for `laravel-lang/native-locale-names`

Author: andrey-helldar

composer.json

@@ -52,7 +52,7 @@
         "laravel-lang/http-statuses": "^3.5.0",
         "laravel-lang/lang": "^13.3.0",
         "laravel-lang/locales": "^1.6",
-        "laravel-lang/native-locale-names": "^1.0",
+        "laravel-lang/native-locale-names": "^1.1",
         "laravel-lang/publisher": "^15.0"
     },
     "require-dev": {

docs/usage/features/native-locale-names.md

@@ -1,12 +1,17 @@
 # Native Locale Names
 
 If you want to get a localized list of languages, then simply call the `Native::get()` method from
-the [`laravel-lang/native-locale-names`](../../installation/index.md) package:
+the [`laravel-lang/native-locale-names`](../../installation/index.md) package.
+
+## Localized Names
 
 ```php
 use LaravelLang\NativeLocaleNames\Native;
+use LaravelLang\Locales\Enums\Locale;
 
 return Native::get('bn');
+// or
+return Native::get(Locale::Bengali)
 ```
 
 Result:
@@ -19,78 +24,165 @@ array:79 [
   "be" => "বেলারুশিয়ান"
   "bg" => "বুলগেরিয়ান"
   "bn" => "বাংলা"
-  "bs" => "বসনিয়ান"
-  "ca" => "কাতালান"
-  "cs" => "চেক"
-  "cy" => "ওয়েলশ"
-  "da" => "ড্যানিশ"
-  "de" => "জার্মান"
-  "de_CH" => "সুইস হাই জার্মান"
-  "el" => "গ্রীক"
-  "en" => "ইংরেজি"
-  "es" => "স্পেনীয়"
-  "et" => "এস্তোনিয়ান"
-  "eu" => "বাস্ক"
-  "fa" => "ফার্সি"
-  "fi" => "ফিনিশ"
-  "fil" => "ফিলিপিনো"
-  "fr" => "ফরাসি"
-  "gl" => "গ্যালিসিয়ান"
-  "gu" => "গুজরাটি"
-  "he" => "হিব্রু"
-  "hi" => "হিন্দি"
-  "hr" => "ক্রোয়েশিয়ান"
-  "hu" => "হাঙ্গেরিয়ান"
-  "hy" => "আর্মেনিয়ান"
-  "id" => "ইন্দোনেশিয়ান"
-  "is" => "আইসল্যান্ডিক"
-  "it" => "ইতালীয়"
-  "ja" => "জাপানিজ"
-  "ka" => "জর্জিয়ান"
-  "kk" => "কাজাখ"
-  "km" => "খমের"
-  "kn" => "কন্নড়"
-  "ko" => "কোরিয়ান"
-  "lt" => "লিথুয়ানিয়ান"
-  "lv" => "লাটভিয়ান"
-  "mk" => "ম্যাসেডোনিয়ান"
-  "mn" => "মঙ্গোলিয়ান"
-  "mr" => "মারাঠি"
-  "ms" => "মলয়"
-  "nb" => "নরওয়েজিয়ান বোকমাল"
-  "ne" => "নেপালি"
-  "nl" => "ডাচ"
-  "nn" => "নরওয়েজিয়ান নাইনরস্ক"
-  "oc" => "অক্সিটান"
-  "pl" => "পোলিশ"
-  "ps" => "পশতু"
-  "pt" => "পর্তুগীজ"
-  "pt_BR" => "ব্রাজিলীয় পর্তুগীজ"
-  "ro" => "রোমানিয়ান"
-  "ru" => "রাশিয়ান"
-  "sc" => "সার্ডিনিয়ান"
-  "si" => "সিংহল"
-  "sk" => "স্লোভাক"
-  "sl" => "স্লোভেন"
-  "sq" => "আলবেনিয়ান"
-  "sr_Cyrl" => "সার্বিয়ান (সিরিলিক)"
-  "sr_Latn" => "সার্বিয়ান (ল্যাটিন)"
-  "sr_Latn_ME" => "সার্বিয়ান (মন্টিনিগ্রো)"
-  "sv" => "সুইডিশ"
-  "sw" => "সোয়াহিলি"
-  "tg" => "তাজিক (সিরিলিক)"
-  "th" => "থাই"
-  "tk" => "তুর্কমেন"
-  "tl" => "তাগালগ"
-  "tr" => "তুর্কি"
-  "ug" => "উইঘুর"
-  "uk" => "ইউক্রেনীয়"
-  "ur" => "উর্দু"
-  "uz_Cyrl" => "উজবেক (সিরিলিক)"
-  "uz_Latn" => "উজবেক (ল্যাটিন)"
-  "vi" => "ভিয়েতনামী"
-  "zh_CN" => "সরলীকৃত চীনা)"
-  "zh_HK" => "চীনা (হংকং)"
-  "zh_TW" => "চীনা (তাইওয়ান)"
+  // ...
+]
+```
+
+## Native Names
+
+You can also get a list of localized names if you call the `get` method without passing parameters.
+The same thing will happen if you pass an incorrect or empty value to the parameter.
+
+```php
+use LaravelLang\NativeLocaleNames\Native;
+
+return Native::get();
+// or
+return Native::get('');
+// or
+return Native::get(null);
+// or
+return Native::get('foo');
+```
+
+Result:
+
+```php
+array:79 [
+  "af" => "Afrikaans"
+  "az" => "Azərbaycan (Latın)"
+  "id" => "Bahasa Indonesia"
+  "bs" => "Bosanski"
+  "ca" => "Català"
+  "cy" => "Cymraeg"
+  "da" => "Dansk"
+  "de" => "Deutsch"
+  "et" => "Eesti Keel"
+  "en" => "English"
+  "es" => "Español"
+  "eu" => "Euskara"
+  "fil" => "Filipino"
+  "fr" => "Français"
+  "gl" => "Galego"
+  "hr" => "Hrvatski"
+  "it" => "Italiano"
+  "sw" => "Kiswahili"
+  "lv" => "Latviski"
+  "lt" => "Lietuvių"
+  "hu" => "Magyar"
+  "ms" => "Melayu"
+  "nl" => "Nederlands"
+  "nb" => "Norsk Bokmål"
+  "nn" => "Norsk Nynorsk"
+  "uz_Cyrl" => "O'zbek (Kirill)"
+  "oc" => "Occitan"
+  "pl" => "Polski"
+  "pt_BR" => "Portugues Do Brasil"
+  "pt" => "Português"
+  "ro" => "Română"
+  "sc" => "Sardinian"
+  "de_CH" => "Schweizer Hochdeutsch"
+  "sr_Latn" => "Serbian (Latin)"
+  "sr_Latn_ME" => "Serbian (Montenegro)"
+  "sq" => "Shqiptare"
+  "sk" => "Slovenský"
+  "sl" => "Slovenščina"
+  "fi" => "Suomalainen"
+  "sv" => "Svenska"
+  "tl" => "Tagalog"
+  "vi" => "Tiếng Việt"
+  "tk" => "Türkmenler"
+  "tr" => "Türkçe"
+  "uz_Latn" => "Uzbek (Latin)"
+  "is" => "Íslenskur"
+  "cs" => "Čeština"
+  "el" => "Ελληνικά"
+  "be" => "Беларускі"
+  "bg" => "Български"
+  "mk" => "Македонски"
+  "mn" => "Монгол"
+  "ru" => "Русский"
+  "sr_Cyrl" => "Српски (Ћирилица)"
+  "tg" => "Тоҷикӣ (Кириллӣ)"
+  "uk" => "Українська"
+  "kk" => "Қазақ"
+  "hy" => "Հայերեն"
+  "he" => "עִברִית"
+  "ug" => "ئۇيغۇر"
+  "ur" => "اردو"
+  "ar" => "عربي"
+  "fa" => "فارسی"
+  "ps" => "پښتو"
+  "ne" => "नेपाली"
+  "mr" => "मराठी"
+  "hi" => "हिंदी"
+  "bn" => "বাংলা"
+  "gu" => "ગુજરાતી"
+  "kn" => "ಕನ್ನಡ"
+  "si" => "සිංහල"
+  "th" => "แบบไทย"
+  "ka" => "ქართული"
+  "km" => "ខ្មែរ"
+  "zh_TW" => "中文（台灣）"
+  "zh_HK" => "中文（香港）"
+  "ja" => "日本語"
+  "zh_CN" => "简体中文）"
+  "ko" => "한국인"
+]
+```
+
+## Sorting
+
+To get the result sorted by key or value, pass `SortBy` to the enum parameter.
+
+By default, sorting by values is applied.
+
+### Sort By Keys
+
+```php
+use LaravelLang\NativeLocaleNames\Native;
+use LaravelLang\NativeLocaleNames\Enums\SortBy;
+
+return Native::get('en', SortBy::Key);
+```
+Result:
+```php
+array:79 [
+  "af" => "Afrikaans"
+  "ar" => "Arabic"
+  "az" => "Azerbaijani (Latin)"
+  "be" => "Belarusian"
+  "bg" => "Bulgarian"
+  "bn" => "Bengali"
+  "bs" => "Bosnian"
+  "ca" => "Catalan"
+  "cs" => "Czech"
+  // ...
+]
+```
+
+### Sort By Values
+
+```php
+use LaravelLang\NativeLocaleNames\Native;
+use LaravelLang\NativeLocaleNames\Enums\SortBy;
+
+return Native::get('en', SortBy::Value);
+// or
+return Native::get('en');
+```
+Result:
+```php
+array:79 [
+  "af" => "Afrikaans"
+  "sq" => "Albanian"
+  "ar" => "Arabic"
+  "hy" => "Armenian"
+  "az" => "Azerbaijani (Latin)"
+  "eu" => "Basque"
+  "be" => "Belarusian"
+  "bn" => "Bengali"
+  "bs" => "Bosnian"
+  // ...
 ]
 ```