README

安装

确保您已安装composer，然后运行以下命令

composer require lyonstahl/fips

这将获取库及其依赖项并将其放入您的vendor文件夹中。

要求

• PHP 7.3+
• Composer 2.0+

使用方法

开始使用State或County类以获取所需的数据。

$state = State::fromName('California');
echo $state->fips; // 06
echo $state->abbreviation; // CA

$counties = $state->getCounties();
echo $counties[0]->name; // Alameda

$county = County::fromFips('06037');
echo $county->name; // Los Angeles
echo $county->getState()->name; // California

这两个类都有四个常见的静态方法

• fromAny((string $value) - 从任何标识符获取州或县对象。函数将尝试猜测标识符的类型。
• fromName(string $name) - 从名称获取州或县对象。
• fromAbbr(string $abbreviation) - 从缩写获取州对象。
• fromFips(string $fips) - 从FIPS代码获取县对象。

最后，这两个类是相互关联的，这意味着您可以从县对象获取州对象，反之亦然。

• State:: getCounties() - 这将获取该州的所有县。
• County:: $state - 州对象作为属性可用。

使用Docker进行开发

我们包含了一个Dockerfile，以便轻松运行测试和调试代码。您必须已安装Docker。以下命令将构建镜像并运行容器

1. docker build -t lyonstahl/fips --build-arg PHP_VERSION=8 .
2. docker run -it --rm -v ${PWD}:/var/www/app lyonstahl/fips sh

在VSCode中使用XDebug进行调试

Docker镜像已配置XDebug。要使用VSCode调试代码，请按照以下步骤操作

1. 在VSCode中安装PHP调试扩展

2. 在VSCode中添加新的PHP调试配置

   {
       "name": "XDebug Docker",
       "type": "php",
       "request": "launch",
       "port": 9003,
       "pathMappings": {
           "/var/www/app/": "${workspaceRoot}/"
       }
   }
   

3. docker run -it --rm -v ${PWD}:/var/www/app --add-host host.docker.internal:host-gateway lyonstahl/fips sh

4. 使用“XDebug Docker”配置在VSCode中开始调试。

测试

此库随PHPUnit一起提供，用于开发。Composer文件已配置了一些脚本，运行以下命令以运行测试

composer test