claz/wishi

一个获取不同国家、州和县的通用包。

安装: 23

依赖项: 0

建议者: 0

安全: 0

星标: 19

关注者: 5

分支: 9

公开问题: 3

类型:项目


README

Coverage Status Build Status StyleCI
如果您曾经需要关于国家和它们州的基本信息,那么定位器(Locator)就是为您准备的。定位器是一个PHP包,与Yahoo API一起工作。只需调用一个方法即可返回您所需的数据。它提供了一个服务提供者(Service Provider)和门面(Facade),以便于与您的Laravel项目集成。它也可以与其他PHP框架如Lumen、CakePHP、Zend等一起使用。版本1.0.0仅提供以下信息:

  • 国家
  • 国家内的州
  • 州内的县

依赖项

  • PHP 5.5+
  • Composer 1.4+
  • Apache

入门指南

要使用此包与PHP项目,首先使用composer安装包。

composer require claz/wishi
  • 请注意,您必须作为开发者注册Yahoo。将您的Yahoo详细信息添加到环境变量中。
YAHOO_CLIENT_ID=*********************************

使用纯PHP

如果您使用的是纯PHP项目,请按照以下步骤操作

  • 如果需要,运行composer dumpautoload
  • 需要autoload.php并加载带有其依赖项的包。
require_once ('vendor/autoload.php')

use Wishi\Controllers\Locator;
  • 实例化定位器类,您就可以开始了。
$locator = new Locator();

与Laravel一起使用

如果您使用的是Laravel,请按照以下步骤操作

  • 打开配置文件夹中的app.config。

  • 在config.php中注册服务提供者。

Wishi\Providers\LocatorServiceProvider::class,
  • 要将门面添加到同一文件。
Locator => Wishi\Facades\Locator::class,
  • 将门面导入到您的项目中。
use Locator;

示例

  • 获取所有国家。
// With normal PHP applications
$countries = $locator->getCountries();

// With the Facade in Laravel applications
$countries = Locator::getCountries();

var_dump($countries); // Collection of countries
  • 获取一个国家中的所有州。
// With normal PHP applications
$states = $locator->getStates('Nigeria');

// With the Facade in Laravel applications
$states = Locator::getStates('Nigeria');

var_dump($states); // Collection of states
  • 获取一个州中的所有县。
// With normal PHP applications
$counties = $locator->getCounties('Lagos');

// With the Facade in Laravel applications
$counties = Locator::getCounties('Lagos');

var_dump($counties); // Collection of counties

以下是一个在Laravel项目中列出尼日利亚所有州的常见用途示例。

<ul>
@foreach(Locator::getStates('Nigeria') as $state)
    <li> {{ $state->name }} </li>
@endforeach
</ul>

许可证

此项目使用MIT许可证,欢迎贡献。