README

GEDCOM X 的 PHP 实现，包括 GEDCOM X 扩展项目。该库仅提供 GEDCOM X 数据和 FamilySearch 扩展的序列化和反序列化类。有关 FamilySearch API PHP SDK 的更多信息，请参阅 gedcomx-php-client。

安装

先决条件

在安装 GedcomX PHP SDK 之前，您必须安装以下组件。

• Composer (PHP 包管理器)

  Mac 开发者的注意事项

  • Mac 开发者可能需要在此过程中安装 Xcode 开发者工具。
  • Mac 开发者可能需要将 /etc/php.ini 中的 date.timezone 设置为避免看到错误。有关如何查找您的时区，请参阅 PHP 时区。例如，

    `date.timezone = "America/Denver"` 
  

您可以通过在命令行或命令提示符中逐行运行以下命令来验证是否已安装所有必需的组件。

php -v
composer --version
git --version

安装步骤

注意：您只需为每个设置的 PHP 项目安装 SDK 一次。

GedcomX PHP SDK 使用 composer 来管理依赖项。这些说明假设您已全局安装了 Composer。

执行以下步骤之一以激活 composer 并安装 gedcomx-php SDK 库

• 在项目根目录的命令提示符中运行以下命令

  composer require gedcomx/gedcomx-php
  

• 将以下配置添加到您的 composer.json 文件中，然后在命令提示符中运行 composer install 命令。

  {
      "require": {
      "gedcomx/gedcomx-php": "^1.1"
      }
  }

特性

• GEDCOM X 概念模型

  在丰富的 PHP 类中实现了 GEDCOM X 概念模型，具有 getter 和 setter 方法。查看 GEDCOM X 概念模型的 视觉图。

• GEDCOM X 序列化

  GEDCOM X 的 XML 和 JSON 序列化和反序列化。有关更多信息，请参阅 示例。

变更日志

• v3.0.0

  • 将 API 网络代码拆分为 gedcomx-php-client

• v2.3.0

  • 向 GedcomxApplicationState 添加 generateClientSecret() 方法。

• v2.2.0

  • 向应用程序状态添加 logout() 方法。

• v2.1.1

  • 支持节流。通过将 throttling 选项设置为 true 在 FamilySearchClient 中启用。

• v2.0.1

  • 修复 FamilySearchClient 以自动遵循重定向。

• v2.0.0

  • 升级到 Guzzle 6，使得 PHP 5.5 成为最低支持版本。
  • $state->getRequest() 返回 GuzzleHttp\Psr7\Request
  • $state->getResponse() 返回 GuzzleHttp\Psr7\Response
  • 在FamilySearchClient中添加一个新的配置参数httpExceptions，当从API收到4xx或5xx响应时将抛出异常。

• v1.2.0

  • 使用FamilySearchClient时添加自定义的用户代理字符串。
  • 使用FamilySearchClient时注册一个PSR-3日志记录器。
  • 向FamilySearchClient类添加setAccessToken()方法。
  • 向PersonsState添加getPerson()方法。将PersonParentsState、PersonSpousesState和PersonChildrenState改为扩展PersonsState。
  • 向FamilySearchClient类添加getStatus()方法。

• v1.1.1

  • 修复FamilySearchClient类中的错误。

• v1.1.0

  • 引入FamilySearchClient。
  • 修复自动化测试。
  • 使用php-vcr提高自动化测试的运行时间。
  • 移除apache/log4php依赖。

• v1.0.0

  • 初始稳定版本，通过版本号启用Composer安装。