somehelper/world-countries

此包提供了所有国家的名称、州、城市名称,以及ISO、STD代码和时区。

3.5.8 2020-05-26 21:12 UTC

README

Build Status Code Quality Code Quality Score Code Grade StyleCI Code Intelligence Status Coverage Status

codecov License Latest Stable Version Latest Unstable Version Total Downloads composer.lock

Laravel WorldCountries 是一个Laravel捆绑包,提供有用的全球信息,包括所有国家名称、时区、ISO国家代码、国家STD代码等。

此包仅提供大约195个国家的国家名称数据,以及洲名、海洋名称、联邦属地名称、世界奇迹名称、ISO代码和ISO信息、时区和时区信息,以及货币和货币代码及符号信息。

还提供按国家划分的州和按州划分的城市信息。

Note: As of now the support for database option is not there, It will be implemented soon.
      (See this area for new updates.)

**请注意,请始终使用此包的最新版本,并且仅使用Laravel 5及以上版本,因为此包可能无法与Laravel的旧版本正确工作。

安装

打开终端,进入根目录,然后运行以下命令

composer require someshwer/world-countries

该包将被安装。

Someshwer\WorldCountries\WorldDataServiceProvider::class 类添加到 providers 数组中的 config/app.php 文件。

Ex:-

'providers' => [
    ...,
    ...,
    Someshwer\WorldCountries\WorldDataServiceProvider::class,
]

现在将别名添加到 aliases 数组中的 config/app.php 文件。

Ex:- 

'aliases' => [
     ...,
     ...,
     'World' => Someshwer\WorldCountries\Facades\World::class,
]

您可以开始通过发布配置来启动。

$ php artisan vendor:publish --provider="Someshwer\WorldCountries\WorldDataServiceProvider"

就是这样!您已完成包的安装...

使用方法

接下来,按照以下方式使用此包

1. World::countries();

它返回世界上所有的国家名称。

2. World::searchCountry('xx');

其中参数 'xx' 是搜索字符串。您可以按搜索字符串搜索国家。如果没有提供搜索字符串,则将返回所有国家名称。

3. World::continents();

它返回所有大洲名称。

4. World::oceans();

它返回世界上所有的海洋名称。

5. World::unionTerritories();

它返回世界上所有的联邦属地名称。

6. World::wonders();

它返回世界上所有的奇迹名称。

7. World::isoCodes();

它返回世界上所有国家的ISO代码。您还可以获取ISO代码的分页结果。如果需要ISO代码的分页,则只需在config/world.php配置文件中将'iso'选项设置为TRUE。您还可以设置每页要显示的记录数。只需查看config/world.php文件中可用的配置选项。

当使用分页时,您必须从请求URL中给出页面号。例如:您正在调用iso代码如World::isoCodes()。对于分页,您必须发送参数为World::isoCodes($request->get('page')),并且URL应为如https://:8000/isoCodes?page=3

8. World::regions();

它返回ISO代码的所有区域名称。

9. World::isoInfoByCountryName('country_name');

其中参数 'country_name' 是国家名称。您可以通过国家名称搜索ISO信息。如果未提供国家名称或提供的国家名称不匹配,则在这两种情况下都将返回空数组。

10. World::isoInfoByCode('country_code');

其中参数 'country_code' 是国家代码。您可以通过国家代码搜索ISO信息。如果未提供国家代码或提供的国家代码不匹配,则在这两种情况下都将返回空数组。

11. World::isoCodesByRegion('region');

其中参数 'region' 是区域名称。您可以通过区域名称搜索ISO信息。如果未提供区域名称或提供的区域名称不匹配,则在这两种情况下都将返回空数组。

12. World::searchIsoCodes('xx');

其中参数 'xx' 是搜索字符串。您可以通过任何搜索字符串搜索ISO信息。如果未提供搜索字符串或提供的搜索字符串不匹配,则在这两种情况下都将返回空数组。

13. World::timezones();

它返回世界上所有时区信息。

14. World::timezoneRegions();

它返回世界上所有时区区域名称。

15. World::timezonesByRegion('region_name');

该函数返回指定区域的所有时区信息。如果提供的区域名称不匹配或者区域名称为空,则返回一个空数组。

16. World::searchTimezone('xx');

您可以通过国家名称或时区名称来搜索时区。其中参数'xx'是搜索字符串。您可以使用任何搜索字符串来搜索时区。如果未提供搜索字符串或提供的搜索字符串不匹配,那么在这两种情况下都会返回一个空数组。

17. World::currencies();

该函数返回几乎所有世界货币的名称及其信息,如国家名称、国家代码、货币代码和货币符号。

18. World::searchCurrency('xx');

您可以通过国家名称或货币名称来搜索货币。其中参数'xx'是搜索字符串。您可以使用任何搜索字符串来搜索货币。如果未提供搜索字符串或提供的搜索字符串不匹配,那么在这两种情况下都会返回一个空数组。

19. World::currencyByCountryName('country_name');

您可以通过国家名称来搜索货币。如果提供的国家名称参数为空或者与数据库文件中的任何值不匹配,则在这种情况下会返回一个空数组作为响应。

20. World::currencyByCountryCode('country_code');

您可以通过国家代码来搜索货币。如果提供的国家代码参数为空或者与数据库中的任何值不匹配,则在这种情况下会返回一个空数组作为响应。

21. World::currencyByCurrencyName('currency_name');

您可以通过货币名称来搜索货币。如果提供的货币名称参数为空或者与数据库文件中的任何值不匹配,则在这种情况下会返回一个空数组。

22. World::currencyByCountryCode('currency_code');

您可以通过货币代码来搜索货币。如果提供的货币代码参数为空或者与数据库中的任何值不匹配,则在这种情况下会返回一个空数组作为响应。

23. World::stdCodes();

该函数返回所有国家的 STD 代码。

24. World::searchStdCodes('xx');

您可以通过搜索字符串来搜索 STD 代码。如果提供的搜索字符串参数为空或者与数据库中的任何值不匹配,则在这种情况下会返回一个空数组作为响应。

25. World::stdCodeByCountryName('country_name');

您可以通过国家名称来搜索 STD 代码。如果提供的国家名称参数为空或者与数据库中的任何值不匹配,则在这种情况下会返回一个空数组作为响应。

26. World::stdCodeByCountryCode('country_code');

您可以通过国家代码来搜索 STD 代码。如果提供的国家代码参数为空或者与数据库中的任何值不匹配,则在这种情况下会返回一个空数组作为响应。

27. World::states();

该函数返回所有州名称及其所属国家的名称。您还可以为州设置分页结果。如果您想要为州设置分页,只需在 config/world.php 配置文件中将 'states' 选项设置为 TRUE。您还可以设置每页显示的记录数。请查阅 config/world.php 文件中可用的配置选项。

当您使用分页时,您必须从请求 URL 中提供页码。例如:您正在调用 states,如 World::states()。对于分页,您必须发送参数为 World::states($request->get('page')),URL 应该如下所示:'https://:8000/states?page=3'。

28. World::searchStates('search_key');

您可以通过任何搜索字符串来搜索州。如果提供的搜索键参数为空或者与数据库中的任何值不匹配,则作为响应返回一个空数组。

29. World::countriesForStates('country_code');

如果您想要通过国家来搜索州,则该函数返回所有国家名称。

30. World::getStatesByCountry('country_name');

您可以通过国家名称来搜索州。如果提供的国家名称参数为空或者与数据库中的任何值不匹配,则作为响应返回一个空数组。

31. World::cities();

该函数返回所有城市名称及其所属的州和国家。您还可以为城市设置分页结果。如果您想要为城市设置分页,只需在 config/world.php 配置文件中将 'cities' 选项设置为 TRUE。您还可以设置每页显示的记录数。请查阅 config/world.php 文件中可用的配置选项。

当使用分页时,您必须在请求URL中提供页码。例如:您正在调用World::cities()这样的城市。对于分页,您必须发送参数作为World::cities($request->get('page')),URL应类似于 'https://:8000/cities?page=3'。

对于分页:URL必须类似于 "https://:8000/cities?page=3",调用cities()函数必须为"return World::cities($request->get('page'));"。否则分页可能无法正常工作。

32. World::searchCities('search_key');

您可以使用任何搜索字符串来搜索城市。如果提供的搜索键作为参数为null或如果它不与数据库中的任何值匹配,则响应将返回空数组。

33. World::statesForCities();

如果您想按州搜索城市,它将返回所有州名。

34. World::countriesForCities();

如果您想按国家搜索城市,它将返回所有国家名。

35. World::getCitiesByStateName('state_name');

您可以使用州来搜索城市。如果提供的州名作为参数为null或如果它与数据库中的任何值不匹配,则响应将返回空数组。

36. World::getCitiesByCountryName('country_name');

您可以使用国家来搜索城市。如果国家名称作为参数为null或如果它与数据库中的任何值不匹配,则响应将返回空数组。