sairum123 / countries
PHP 国家和货币
Requires
- php: >=7.0
- colinodell/json5: ^1.0|^2.0
- nette/caching: ^2.5|^3.0
- pragmarx/coollection: >=0.5
- psr/simple-cache: ^1.0
Requires (Dev)
- gasparesganga/php-shapefile: ^2.4
- phpunit/phpunit: ~6.0|~7.0|~8.0
- squizlabs/php_codesniffer: ^2.3
README
国家
重创建此包的原因
我不是此包的原始作者,我只是修改了这个包,因为我必须包含一些我的项目中需要的缺失城市,我已经在原始包上提出了合并请求,但作者还没有合并,一旦它被合并到原始包中,我就会移除我的修改版包,谢谢
它为你提供了什么?
此包包含了关于国家的各种信息
地质和拓扑地图
在众多其他信息中,你可以绘制国家地图
要求
- PHP 7.0+
安装
使用 Composer 安装它
composer require pragmarx/countries
实例化
use PragmaRX\Countries\Package\Countries; $countries = new Countries(); echo $countries->where('cca2', 'IT')->first()->hydrateCurrencies()->currencies->EUR->coins->frequent->first(); // or calling it statically echo Countries::where('cca2', 'IT')->first()->hydrateCurrencies()->currencies->EUR->coins->frequent->first();
两者都应该返回
€1
覆盖默认配置
use PragmaRX\Countries\Package\Services\Config; $countries = new Countries(new Config([ 'hydrate' => [ 'elements' => [ 'currencies' => true, 'flag' => true, 'timezones' => true, ], ], ]));
用法
此包与 Laravel 无关,也不需要安装 Laravel(我们为此目的有一个桥梁),但它在其核心中包含了Laravel Collections,Collections 中的所有方法都可用,这样你可以进行诸如过滤、映射、归约、搜索、排序、拒绝等操作。实际上,它使用Coollection,这是一个具有流畅语法的 Laravel Collections,允许我们以对象属性的方式访问数组键(和值)。
要获取数据库中的所有国家,只需这样做
use PragmaRX\Countries\Package\Countries; $countries = new Countries(); $all = $countries->all();
要获取 JSON,你
return $countries->toJson();
通过键和值过滤
$countries->where('name.common', 'Brazil');
可以通过其常用名称找到巴西,该名称是
#items: array:22 [▼
"name" => array:3 [▼
"common" => "Brazil"
"official" => "Federative Republic of Brazil"
"native" => array:1 [▼
"por" => array:2 [▼
"official" => "República Federativa do Brasil"
"common" => "Brasil"
]
]
]
或者你也可以这样过滤
$countries->whereNameCommon('Brazil');
并且你可以更深入地挖掘
$countries->where('name.native.por.common', 'Brasil');
或者通过国家顶级域名进行搜索
$countries->where('tld.0', '.ch');
要获取
"name" => array:3 [▼
"common" => "Switzerland"
"official" => "Swiss Confederation"
"native" => array:4 [▶]
]
"tld" => array:1 [▼
0 => ".ch"
]
并使用像 pluck 这样的东西
$countries->where('cca3', 'USA')->first()->hydrateStates()->states->pluck('name', 'postal')->toArray();
要获取
"MA" => "Massachusetts" "MN" => "Minnesota" "MT" => "Montana" "ND" => "North Dakota" ...
该包使用一个修改过的 Collection,允许你以对象的方式访问属性和方法
$countries->where('cca3', 'FRA') ->first() ->borders ->first() ->name ->official;
应该给出
Principality of Andorra
默认禁用边界水合,但你可以通过调用 hydrate 方法轻松地将边界水合
$countries->where('name.common', 'United Kingdom') ->hydrate('borders') ->first() ->borders ->reverse() ->first() ->name ->common;
应该返回
Ireland
水合
为了提高性能,默认启用水合可以在大多数国家属性上禁用,这是手动水合属性的方法
$countries->where('name.common', 'United States')->first()->hydrate('timezones')->timezones->first()->zone_name; $countries->where('name.common', 'United States')->first()->hydrate('timezones')->timezones->first()->zone_name;
这些是一些可水合的属性
- 边界
- 城市
- 货币
- 旗帜
- 几何形状
- 语言
- 州
- 税收
- 时区
- 拓扑
额外的 WHERE 规则
某些属性以不同的方式存储,因此我们需要特殊规则来访问它们,这些属性是
ISO639_3
=> 3个字母的语言代码。ISO4217
=> 3个字母的货币代码。
当然,你可以像其他属性一样访问它们
$countries->whereISO639_3('por')->count(); $countries->where('ISO639_3', 'por')->count();
映射
有时你可能想通过不同的名称访问一个属性,这可以在设置中完成,这样
'maps' => [ 'lca3' => 'ISO639_3' ]
这里我们将 ISO 格式的 3 个字母语言简码绑定到 lca3
,它是 language code alpha 3-letter
的缩写。现在我们可以通过这种方式访问属性
$countries->whereLca3('por');
或
$countries->where('lca3', 'por');
一些来自 Laravel News 和其他贡献者的示例
生成所有带代码的国家列表,使用本地名称和常用
app(PragmaRX\Countries\Package\Countries::class) ->all() ->map(function ($country) { $commonName = $country->name->common; $languages = $country->languages ?? collect(); $language = $languages->keys()->first() ?? null; $nativeNames = $country->name->native ?? null; if ( filled($language) && filled($nativeNames) && filled($nativeNames[$language]) ?? null ) { $native = $nativeNames[$language]['common'] ?? null; } if (blank($native ?? null) && filled($nativeNames)) { $native = $nativeNames->first()['common'] ?? null; } $native = $native ?? $commonName; if ($native !== $commonName && filled($native)) { $native = "$native ($commonName)"; } return [$country->cca2 => $native]; }) ->values() ->toArray();
应该给你 267(或更多)个国家,如下所示
"AW" => "Aruba"
"AF" => "افغانستان (Afghanistan)"
"AO" => "Angola"
"AI" => "Anguilla"
"AX" => "Åland (Åland Islands)"
"AL" => "Shqipëria (Albania)"
"AD" => "Andorra"
"AE" => "دولة الإمارات العربية المتحدة (United Arab Emirates)"
"AR" => "Argentina"
"AM" => "Հայաստան (Armenia)"
"AS" => "American Samoa"
"AQ" => "Antarctica"
"TF" => "Terres australes et antarctiques françaises (French Southern and Antarctic Lands)"
"AG" => "Antigua and Barbuda"
"AU" => "Australia"
"AT" => "Österreich (Austria)"
"AZ" => "Azərbaycan (Azerbaijan)"
"BI" => "Burundi"
"BE" => "Belgien (Belgium)"
"BJ" => "Bénin (Benin)"
"BF" => "Burkina Faso"
"BD" => "বাংলাদেশ (Bangladesh)"
"BG" => "България (Bulgaria)"
"BH" => "البحرين (Bahrain)"
"BS" => "Bahamas"
"BA" => "Bosna i Hercegovina (Bosnia and Herzegovina)"
"BL" => "Saint-Barthélemy (Saint Barthélemy)"
"SH" => "Saint Helena, Ascension and Tristan da Cunha"
"BY" => "Белару́сь (Belarus)"
"BZ" => "Belize"
"BM" => "Bermuda"
"BO" => "Wuliwya (Bolivia)"
"BQ" => "Caribisch Nederland (Caribbean Netherlands)"
"BR" => "Brasil (Brazil)"
"BB" => "Barbados"
"BN" => "Negara Brunei Darussalam (Brunei)"
"BT" => "འབྲུག་ཡུལ་ (Bhutan)"
"BV" => "Bouvetøya (Bouvet Island)"
"BW" => "Botswana"
"CF" => "République centrafricaine (Central African Republic)"
"CA" => "Canada"
"CC" => "Cocos (Keeling) Islands"
"CH" => "Suisse (Switzerland)"
"CL" => "Chile"
"CN" => "中国 (China)"
"CI" => "Côte d'Ivoire (Ivory Coast)"
"CM" => "Cameroon"
"CD" => "RD Congo (DR Congo)"
"CG" => "République du Congo (Republic of the Congo)"
"CK" => "Cook Islands"
"CO" => "Colombia"
"KM" => "القمر (Comoros)"
"CV" => "Cabo Verde (Cape Verde)"
...
生成国家列表
$countries->all()->pluck('name.common')->toArray();
返回
[ "Aruba", "Afghanistan", "Angola", "Anguilla", "Åland Islands", ....
生成货币列表
$countries->all()->pluck('currencies')->toArray();
返回
[ [ "AWG", ], [ "AFN", ], [ "AOA", ], [ "XCD", ], [ "EUR", ], ....
获取货币符号
$countries->where('name.common', 'Brazil')->first()->hydrate('currencies')->currencies->BRL->units->major->symbol;
生成州列表
$countries->where('name.common', 'United States') ->first() ->hydrateStates() ->states ->sortBy('name') ->pluck('name', 'postal');
返回
[ "AL": "Alabama", "AK": "Alaska", "AZ": "Arizona", "AR": "Arkansas", "CA": "California", .... ....
注入数据并获取城市
$countries->where('cca3', 'FRA') ->first() ->hydrate('cities') ->cities ->paris ->timezone;
应该返回
Europe/Paris
获取国家的货币
$countries->where('name.common', 'United States')->first()->currencies;
返回
[{ "alternativeSigns": [], "ISO4217Code": "USD", "ISO4217Number": "840", "sign": "$", "subunits": 100, "title": "U.S. dollar", ....
获取所有货币
$countries->currencies();
返回
[ 0 => "AED" 1 => "AFN" 2 => "ALL" 3 => "AMD" 4 => "ANG" 5 => "AOA" 6 => "ARS" 7 => "AUD" 8 => "AWG" 9 => "AZN" 10 => "BAM" ....
获取州的时区
return $countries->where('name.common', 'United States')->first()->timezone->NC;
返回
America/New_York
获取国家的所有时区
$countries->where('name.common', 'Brazil') ->first() ->hydrateTimezones() ->timezones ->map(function ($timezone) { return $timezone->zone_name; })->values() ->unique() ->toArray();
获取时区的所有时间
return $countries->where('name.common', 'United States Virgin Islands')->first()->hydrate('timezones_times')->timezones->first()->times;
返回
"times" => [ "abbreviation" => "LMT" "dst" => "0" "gmt_offset" => "-14764" "time_start" => "-1825098837" "zone_id" => "415" 1 => [ "abbreviation" => "AST" "dst" => "0" "gmt_offset" => "-14400" "time_start" => "-1825098836" "zone_id" => "415" ] ]
旗帜
国家提供许多不同的旗帜来源,包括SVG旗帜。这是使用可用来源之一的方法
安装 flag-icon
npm install --save-dev flag-icon-css
将其导入您的项目
@import '~flag-icon-css/sass/flag-icon.scss';
使用Countries获取旗帜span
$unitedStatesFlag =
$this->countries->where('cca3', 'USA')
->first()
->flag
->flag_icon;
在blade模板中渲染它
{!! $unitedStatesFlag !!}
发布资产
您可以通过以下方式发布配置:
php artisan vendor:publish --provider=PragmaRX\\Countries\\ServiceProvider
数据
来源
此包使用一些其他开源包,在我们不构建更好的文档之前,您可以在mledoze/countries上找到有关数据的更多信息,以及如何在Laravel News文章中使用它。
请查看版权部分,以获取此包使用的所有包的完整列表。
更新
该包附带update.php
脚本,您可以使用它来更新它使用的数据。它将下载所有包的所有信息,并自动构建我们拥有的.json
文件,所以如果您发现有什么错误,您可以要求那些包管理器修复它,然后您只需运行它
cd vendor/pragmarx/countries
composer install
php update.php
等待一个非常长的时间*(有时它看起来像卡住了,但其实没有)直到它完成重建一切,然后只是进行预发布、提交、推送所有重新生成的文件,并草拟一个新的PR。
缓存
由于这些数据不应更改,调用将自动缓存。如果您想更改此行为,可以在发布后编辑config/countries.php
文件。
框架桥接
示例文件
- sample-partial.json:没有注入边界的国家示例。
- sample-full.json:完全注入的国家示例。
作者
版权
为了构建国家数据库和关系,此包使用以下来源和包
许可
Countries在BSD 3-Clause License下授权 - 有关详细信息,请参阅LICENSE
文件
贡献
欢迎提交拉取请求和问题。