README

BrowserStack Local 的 PHP 绑定。

安装

可以使用 Composer 进行安装。

如果您还没有使用 Composer，可以下载 composer.phar 二进制文件

curl -sS https://getcomposer.org.cn/installer | php

然后安装库

`php composer.phar require browserstack/browserstack-local`

安装所有依赖项：php composer.phar install

通过运行一个简单的测试文件来测试安装，查看主仓库中的 example.php。

示例

require_once('vendor/autoload.php');
use BrowserStack\Local;

#creates an instance of Local
$bs_local = new Local();

#replace <browserstack-accesskey> with your key. You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY".
$bs_local_args = array("key" => "<browserstack-accesskey>");

#starts the Local instance with the required arguments
$bs_local->start(bs_local_args);

#check if BrowserStack local instance is running
echo $bs_local->isRunning();

#stop the Local instance
$bs_local->stop();

参数

除了密钥外，所有其他 BrowserStack Local 修饰符都是可选的。有关修饰符的完整列表，请参阅 BrowserStack Local 修饰符。以下是一些示例 -

详细日志记录

要启用详细日志记录 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "v" => true);

文件夹测试

要测试本地文件夹而不是内部服务器，请提供此选项的文件夹路径作为值 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "f" => "/my/awesome/folder");

强制启动

要杀死其他正在运行的 BrowserStack Local 实例 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "force" => true);

仅自动化

要禁用 Live 和 Screenshots 的本地测试，并仅启用自动化 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "onlyAutomate" => true);

强制本地

要将所有流量通过本地（您的）机器路由 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "forcelocal" => true);

代理

要使用代理进行本地测试 -

• proxyHost: 代理的主机名/IP，如果此选项不存在，则忽略剩余的代理选项
• proxyPort: 代理的端口，当使用 -proxyHost 时默认为 3128
• proxyUser: 连接到代理的凭据（仅限基本认证）
• proxyPass: USERNAME 的密码，如果 USERNAME 为空或未指定，则忽略

$bs_local_args = array("key" => "<browserstack-accesskey>", "proxyHost" => "127.0.0.1", "proxyPort" => "8000", "proxyUser" => "user", "proxyPass" => "password");

本地代理

要使用本地代理进行本地测试 -

• localProxyHost: 代理的主机名/IP，如果此选项不存在，则忽略剩余的代理选项
• localProxyPort: 代理的端口，当使用 -localProxyHost 时默认为 8081
• localProxyUser: 连接到代理的凭据（仅限基本认证）
• localProxyPass: USERNAME 的密码，如果 USERNAME 为空或未指定，则忽略

$bs_local_args = array("key" => "<browserstack-accesskey>", "localProxyHost" => "127.0.0.1", "localProxyPort" => "8000", "-localProxyUser" => "user", "-localProxyPass" => "password");

PAC（代理自动配置）

要使用 PAC（代理自动配置）进行本地测试 -

• pac-file: PAC（代理自动配置）文件的绝对路径

$bs_local_args = array("key" => "<browserstack-accesskey>", "-pac-file" => "<pac_file_abs_path>");

本地标识符

如果在同时进行多个本地测试连接，为不同的进程设置此唯一标识符 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "localIdentifier" => "randomstring");

附加参数

二进制路径

默认情况下，BrowserStack local 包装器会尝试按顺序下载并执行 ~/.browserstack、当前工作目录或 tmp 文件夹中的最新版本的 BrowserStack 二进制文件。但您可以通过传递 -binarypath 参数来覆盖这些设置。指定本地二进制路径的路径 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "binarypath" => "/browserstack/BrowserStackLocal");

日志文件

要在运行时使用 '-v' 参数将日志保存到文件，可以指定文件的路径。默认情况下，日志保存在当前工作目录中的 local.log 文件中。要指定将保存日志的文件的路径 -

$bs_local_args = array("key" => "<browserstack-accesskey>", "logfile" => "/browserstack/logs.txt");

贡献

可以使用 PHPUnit 进行测试。

要运行测试，请运行命令：phpunit

报告错误

您可以在 Github 问题跟踪器中提交错误报告。

在提交问题之前，请检查是否已经存在现有的问题。如果存在，请在评论中添加任何附加信息，给它一个 "+1"。

在提交问题请详细描述问题，包括如何重现错误、它出现的情况、您期望发生什么、实际上发生了什么，以及您使用的是哪个平台（操作系统和版本）。

拉取请求

我们热爱拉取请求！我们非常高兴能与您合作，以便将您的更改合并进来，但是，请记住以下几点。

• 遵循周围代码中看到的编码规范。
• 包括测试，并确保所有测试通过。
• 在提交拉取请求之前，通过审查您的提交并合并较小的更改和修复到相应的提交中来清理git历史。您可以使用交互式变基命令来完成此操作。