Google 身份工具包(Identity Toolkit)PHP 客户端库安装与使用指南
1. 项目目录结构及介绍
.
├── src # 包含主要的类和接口文件
│ └── Gitkit_Client.php # 主要的客户端类
└── tests # 单元测试相关代码
├── functional # 功能性测试
└── unit # 单元测试
├── composer.json # 项目依赖管理文件
├── AUTHORS # 作者列表
├── CONTRIBUTORS # 贡献者列表
├── LICENSE.md # 开源许可证文件
└── README.md # 项目说明文件
src
目录包含了 Gitkit_Client.php
文件,这是项目的核心类,提供了与 Google Identity Toolkit 服务交互的方法。
tests
目录存放了测试代码,分为单元测试和功能性测试,帮助确保代码质量。
composer.json
是 Composer 配置文件,定义了项目依赖和其他设置。
其他文件如 AUTHORS
和 CONTRIBUTORS
列出了项目的作者和贡献者,LICENSE.md
描述了项目的开源许可证。
2. 项目启动文件介绍
Google Identity Toolkit PHP 客户端库没有一个标准的启动文件,因为它作为库被集成到其他 PHP 应用中使用。您通常会在自己的应用程序中创建一个入口点来实例化 Gitkit_Client
类并调用其方法。例如:
require_once __DIR__ . '/vendor/autoload.php';
$gitkitClient = Gitkit_Client::createFromFile("gitkit-server-config.json");
// 接下来使用 $gitkitClient 对象进行身份验证操作
这里,autoload.php
是通过 Composer 安装依赖时自动生成的,用于自动加载项目中的类。gitkit-server-config.json
是服务器配置文件,包含了 API 密钥和其它必要设置。
3. 项目的配置文件介绍
Google Identity Toolkit PHP 客户端库的配置文件通常是名为 gitkit-server-config.json
的 JSON 格式文件。该文件包括以下关键字段:
{
"project_id": "YOUR_PROJECT_ID",
"client_id": "YOUR_CLIENT_ID",
"service_account_email": "YOUR_SERVICE_ACCOUNT_EMAIL",
"private_key_file": "/path/to/private/key.pem", // 可选,用于服务帐户认证
"cookie_name": "YOUR_COOKIE_NAME", // 用户认证的 cookie 名称
"widget_url": "YOUR_WIDGET_URL", // 身份工具包 widget URL
"site_url": "YOUR_SITE_URL", // 网站的主URL
"token_validity_seconds": 3600, // 认证令牌的有效时间
}
project_id
: Google Firebase 项目ID。client_id
: Google Identity Toolkit (现在称为Firebase Authentication) 的客户端ID。service_account_email
: Google Cloud Platform上的服务帐户电子邮件地址。private_key_file
: 服务帐户私钥文件路径(如果使用服务帐户认证)。cookie_name
: 存储身份工具包认证数据的客户端Cookie名称。widget_url
: 身份工具包的Widget URL,用于前端显示登录表单。site_url
: 应用程序的网站URL,用于验证请求来源。token_validity_seconds
: 令牌的有效期(以秒为单位)。
请确保替换上述占位符为实际的值,然后在您的应用中引用这个配置文件。
注意,此库已被官方归档,可能不再维护。在新项目中,建议查看 Firebase Authentication 的最新文档以获取适用于 PHP 的解决方案。