⚠️ This project is deprecated and no longer supported
The gedcomx-php SDK is the PHP implementation of GEDCOM X, including GEDCOM X extension projects.
See the wiki for the following:
Prior to installing the GedcomX PHP SDK you must install the following components.
PHP 5.5+ (The language of this SDK)
Git (Versioning system for coding)
Composer (PHP Packages Manager)
Notes to Mac Developers:
date.timezone
in /etc/php.ini to avoid seeing errors. See PHP time zones to locate your time zone. For example,
`date.timezone = "America/Denver"`
You can verify that each of the required components is installed by running the following commands one line at a time, at your command line or command prompt:
php -v
composer --version
git --version
NOTE: You only need to install the SDK one time for each PHP project you set up.
The GedcomX PHP SDK uses composer to manage dependencies. These instructions assume that you have installed Composer globally.
Do one of the following steps to activate Composer and install the gedcomx-php SDK library:
Run the following command at a command prompt from the root of your project:
composer require gedcomx/gedcomx-php-client
Add the following configuration to your composer.json file then run the composer install
command at your command prompt.
{
"require": {
"gedcomx/gedcomx-php-client": "^1.1"
}
}
GEDCOM X Conceptual Model
Implementaton of the GEDCOM X Conceptual Model in a rich set of PHP Classes with getter and setter methods. Take a look at a visual graph of the GEDCOM X Conceptual Model.
GEDCOM X Serialization
XML and JSON serialization and deserialization of GEDCOM X. For more information, see the examples.
GEDCOM X RS Client
Functionality to interact with a GEDCOM X RS compliant web service. GEDCOM X RS is a RESTful specification that defines a set of application states for a genealogical data application. This allows you to read the state of a Person, Relationship, Source Description, or other state. Take a look as some examples of establishing a RESTful state.
FamilySearch API Interface
A robust mechanism for interacting with the FamilySearch API. The FamilySearchClient class makes it easy to set the configuration to the appropriate API environment (Sandbox, Beta, Production), authenticate using OAuth2, and interact with the FamilySearch Family Tree and other services.
v3.0.3
api-integ
subdomain instead of integration
.v3.0.2
api
subdomain in production.v3.0.1
integration
instead of sandbox
.v3.0.0
v2.3.0
generateClientSecret()
method to GedcomxApplicationState
.v2.2.0
logout()
method to application states.v2.1.1
FamilySearchClient
by setting the throttling
option to true
.v2.0.1
FamilySearchClient
so that it automatically follows redirects.v2.0.0
$state->getRequest()
returns a GuzzleHttp\Psr7\Request
$state->getResponse()
returns a GuzzleHttp\Psr7\Response
httpExceptions
configuration parameter on FamilySearchClient
that causes an exception to be thrown when a 4xx or 5xx response is received from the API.v1.2.0
setAccessToken()
method to the FamilySearchClient class.getPerson()
method to the PersonsState. Change PersonParentsState, PersonSpousesState, and PersonChildrenState to extend PersonsState.getStatus()
method to the FamilySearchClient class.v1.1.1:
v1.1.0:
v1.0.0: