README

一个PHP包装器，用于辅助使用由http://www.thebluealliance.com提供的API

安装

Composer

通过Composer安装应用是设置最快的方式。在终端中导航到项目的根目录，然后运行

composer require dacotahharvey/thebluealliance-phpwrapper

然后当您使用项目时，在文件顶部包含以下两行

require_once __DIR__ . '/lib/vendor/autoload.php';
use TheBlueAlliance_PHPWrapper\TBARequest;

手动克隆

1. 在项目中创建一个名为tbaAPI的新文件夹
2. 下载此仓库。
3. 解压您下载的文件，并将它们放入之前创建的tbaAPI文件夹中。
4. 在您希望使用包装器的文件顶部包含以下行

include __DIR__ . '/tbaapi/TBARequest.php';

库使用

要使用此库，您需要从The Blue Alliance获取API密钥。有关如何获取的更多信息，请参阅此处 https://www.thebluealliance.com/apidocs

1. 创建对库的新引用，如下所示

$tbaRequest = new tbaAPI\TBARequest(api_key);

1. 调用提供的函数来检索数据，如下所示

echo $tbaRequest->getDistricts(['year' => 2016]);

包装器提供的所有函数都接受相同的三个参数

1. $request_parameters - 端点查询所需的任何参数
2. $headers - 您想要与请求一起发送的任何附加头信息
3. $full_response - 您是否想要完整的响应或仅The Blue Alliance返回的JSON

例如，如果我们想要向获取队伍1114的请求。我们可以在这里找到此函数的文档。使用上面的var tba，我们可以执行以下操作

$result = $tbaRequest->getTeam(['team' => 1114]);

执行预制脚本

一旦完成初始设置，执行PHP脚本非常简单。与此项目一起提供的脚本在PHP 7上运行效果最佳，但它们也可以在较低版本上运行。运行此仓库中包含的脚本非常简单。可以通过以下三个步骤完成

1. 克隆仓库
2. 在每个脚本中，您都会找到库的初始化。您必须更改每个您想要运行的脚本，因为目前它们都是空的。您可以在Readme中的库使用部分找到有关如何执行此操作的信息。
3. 在终端中使用以下命令。注意，composer install只用于一次生成必须存在以正确使用插件的自加载文件

composer install
cd scripts
cd 2017

然后选择您要运行的文件。每个脚本都会包含运行说明。如果您尝试使用不正确的命令运行脚本，它会告诉您应该如何运行。以下是一个示例，说明您进入正确的目录后如何执行脚本：

php team-match-turnaround.php 2017dar frc1114

脚本将在您的终端实例中运行。

Mac OSX中的PHP安装

Mac OSX默认自带PHP！如果您有抱负，可以将PHP升级到7。以下教程步骤将帮助您完成此操作。

1. Homebrew是将您的Mac实例升级到PHP7的最佳方式。Homebrew是一个允许您通过终端安装软件包的工具。有关Homebrew是什么以及如何使用的精彩教程，请参阅此处：https://www.howtogeek.com/211541/homebrew-for-os-x-easily-installs-desktop-apps-and-terminal-utilities/

2. 此教程是升级到PHP7的绝佳参考点。您还可以按相反顺序执行这些步骤，将PHP降级回5！https://developerjack.com/blog/2015/12/11/Installing-PHP7-with-homebrew/

Windows上的PHP安装

在Windows上通过命令行安装PHP是一项艰巨的任务。PHP库提供了一个关于此的教程，您可以在以下位置找到：https://php.ac.cn/manual/pl/install.windows.commandline.php

或者您可以使用Xxamp。Xxamp的主页（包含下载链接）如下：https://www.apachefriends.org/index.html，有关如何使用xxamp的精彩教程请参阅此处：https://blog.udemy.com/xampp-tutorial/

联系我

如果您有任何问题或疑虑，请随时通过以下邮箱联系我：dacotahj.harvey@gmail.com 我非常愿意帮助您编写脚本或设置环境，以便您执行自己的脚本！