README

简介

欢迎使用IPLocator，这是一个功能强大的Laravel包，它提供了易于使用的功能，用于检索关于IP地址的详细信息。使用此包，您可以轻松地获取有关位置、货币、语言等重要信息。

功能

准确的IP信息：IPLocator使用可靠的数据源来提供关于IP地址地理位置的准确信息。
货币和语言详情：检索与提供的IP地址相关的货币和语言信息。
简单集成：无缝地将IPLocator包集成到您的Laravel项目中，无需麻烦。
可定制选项：根据您的应用程序需求定制包设置。
快速高效：IPLocator设计高效，确保对应用程序性能的影响最小。
定期更新：该包得到积极维护，并将定期提供更新以保持数据的最新性。

要求

Laravel 7.x 或更高版本
PHP 7.4 或更高版本

安装

您可以通过Composer安装IPLocator包。在您的终端中运行以下命令

composer require bytes4sale/iplocator

先决条件

在使用IPLocator之前，您需要从您希望使用的IP数据提供商处注册API密钥。IPLocator目前支持以下IP数据提供商，每个提供商都提供不同的一组信息。因此，需要密钥来访问他们的API以获取IP信息

IPDATA：您可以通过访问他们的网站来注册并获得API密钥。
IPSTACK：您可以通过访问他们的网站来注册并获得API密钥。

配置

在使用IPLocator包之前，您需要在您的Laravel项目的.env文件中设置您的API密钥和API源。

打开您的Laravel项目根目录。
创建或修改.env文件并添加

//for IPDATA
IP_LOCATOR_SOURCE=IPDATA
IPDATA_KEY=your_ipdata_api_key_here,

//for IPSTACK
IP_LOCATOR_SOURCE=IPSTACK
IPSTACK_KEY=your_ipstack_api_key_here,

//for IP-API
IP_LOCATOR_SOURCE=IP-API

使用方法

使用IPLocator获取IP地址信息非常简单。只需遵循以下步骤

初始化IPLocator：在使用包之前，请确保初始化它。您可以通过将 ServiceProvider 添加到 config/app.php 文件来实现
```
// config/app.php

'providers' => [
    // Other providers...
    bytes4sale\iplocator\IpLocatorServiceProvider::class,
],
```

检索IP信息：一旦初始化了包，您就可以轻松地获取IP地址的详细信息

 use bytes4sale\iplocator\Facades\IPLocator;

// Get information for an IP address
 $ipAddress = '203.0.113.0';
 $response  = IPLocator::getIpCompleteDetails($ipAddress);
 if ($response->isSuccessful()) {
     print_r($response->getTodayRequestCount());
      
     } else {
         print_r($response->getErrorResponse();
     }

配置

IPLocator允许您通过发布其配置文件来自定义其行为。为此，请运行以下 artisan 命令

php artisan vendor:publish --tag="iplocator-config"

运行命令后，您将在 config/iplocator.php 中找到配置文件。您可以按需修改设置。

高级设置

如果您想将API密钥保存在数据库中，可以使用 IpLocatorConfig::setCredentials(["key" => "123"]) 函数来设置API密钥。请确保数组键应该是 "key"。

这允许您在应用程序的数据库中安全地存储和管理API密钥，提供更灵活和可配置的使用IpLocator包的方式。

可用方法

贡献和错误报告

我们欢迎社区对 bytes4sale IPLocator 的贡献。如果您发现错误或有新功能建议，我们鼓励您参与并帮助使此包变得更好。

错误报告

在使用bytes4sale IPLocator时，如果您遇到任何问题或错误，请在我们的GitHub仓库中打开一个问题。在报告错误时，请尽可能提供详细信息，包括

一个清晰且描述性的问题标题。
重现错误的步骤。
关于您的PHP和Laravel版本的信息。
任何相关的错误消息或截图。

功能请求

如果您有新的功能想法或改进，您也可以在我们的GitHub仓库中打开一个问题。请概述该功能的性能和它解决的问题或对包增加的价值。

贡献

我们感谢社区对我们的贡献，以帮助我们改进这个包。如果您想贡献代码，请按照以下步骤操作

从master分支分叉仓库并创建一个新的分支。
实施您的更改或添加。
编写测试以确保新代码能正确运行，并根据需要更新现有测试。
确保所有测试通过。
创建一个拉取请求（PR）以提交您的更改。清楚地描述您所做的更改以及任何相关的问题或功能。

我们的团队将审查您的PR，如果一切顺利，我们将将其合并到master分支。

通过为bytes4sale IPLocator做出贡献，您同意将您的贡献提供给这个包。

我们感谢贡献者的努力，您的帮助将使这个包对每个人来说都变得更好。谢谢您！

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。

致谢

如果您觉得这个包很有用，请考虑给予作者和贡献者应有的认可。

bytes4sale / iplocator

维护者

详细信息