2017 © Pedro Peláez
 

library gedcomx-php

PHP libraries for GEDCOM X.

image

gedcomx/gedcomx-php

PHP libraries for GEDCOM X.

  • Thursday, November 17, 2016
  • by stoicflame
  • Repository
  • 28 Watchers
  • 23 Stars
  • 560 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 11 Forks
  • 5 Open issues
  • 24 Versions
  • 1 % Grown

The README.md

GedcomX - PHP SDK

Packagist Build Status Coverage Status Dependency Status, (*1)

The PHP implementation of GEDCOM X, including GEDCOM X extension projects. The library only provides classes for serialization and deserialization of GEDCOM X data and FamilySearch extensions. See gedcomx-php-client for the FamilySearch API PHP SDK., (*2)

Installation

Prerequisites

Prior to installing the GedcomX PHP SDK you must install the following components., (*3)

  • Composer (PHP Packages Manager), (*4)

    Notes to Mac Developers:, (*5)

    • Mac developers might need to install the Xcode developer tools as part of this process.
    • Mac developers may need to set the 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:, (*6)

php -v
composer --version
git --version

Installation Steps

NOTE: You only need to install the SDK one time for each PHP project you set up., (*7)

The GedcomX PHP SDK uses composer to manage dependencies. These instructions assume that you have installed Composer globally., (*8)

Do one of the following steps to activate Composer and install the gedcomx-php SDK library:, (*9)

  • Run the following command at a command prompt from the root of your project:, (*10)

    composer require gedcomx/gedcomx-php
    
  • Add the following configuration to your composer.json file then run the composer install command at your command prompt., (*11)

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

Features

  • GEDCOM X Conceptual Model, (*12)

    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., (*13)

  • GEDCOM X Serialization, (*14)

    XML and JSON serialization and deserialization of GEDCOM X. For more information, see the examples., (*15)

Changelog

  • v3.0.0, (*16)

  • v2.3.0, (*17)

    • Add the generateClientSecret() method to GedcomxApplicationState.
  • v2.2.0, (*18)

    • Add logout() method to application states.
  • v2.1.1, (*19)

    • Support throttling. Enable in FamilySearchClient by setting the throttling option to true.
  • v2.0.1, (*20)

    • Fix FamilySearchClient so that it automatically follows redirects.
  • v2.0.0, (*21)

    • Upgrade to Guzzle 6 which makes PHP 5.5 the minimum supported version.
    • $state->getRequest() returns a GuzzleHttp\Psr7\Request
    • $state->getResponse() returns a GuzzleHttp\Psr7\Response
    • Add a new 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, (*22)

    • Add a custom user agent string when using the FamilySearchClient.
    • Register a PSR-3 logger when using the FamilySearchClient.
    • Add a setAccessToken() method to the FamilySearchClient class.
    • Add getPerson() method to the PersonsState. Change PersonParentsState, PersonSpousesState, and PersonChildrenState to extend PersonsState.
    • Add getStatus() method to the FamilySearchClient class.
  • v1.1.1:, (*23)

    • Fix bugs in the FamilySearchClient class
  • v1.1.0:, (*24)

    • Introduce the FamilySearchClient
    • Fix automated tests
    • Improve runtime of automated tests with php-vcr
    • Remove apache/log4php dependency
  • v1.0.0:, (*25)

    • Initial stable build to enable Composer installation by version number.

The Versions

17/11 2016

dev-master

9999999-dev https://github.com/FamilySearch/gedcomx-php

PHP libraries for GEDCOM X.

  Sources   Download

Apache-2.0

The Development Requires

sdk genealogy gedcomx familysearch

17/11 2016
17/11 2016
17/11 2016
20/09 2016

dev-split

dev-split https://github.com/FamilySearch/gedcomx-php

PHP libraries for GEDCOM X.

  Sources   Download

Apache-2.0

The Development Requires

sdk genealogy gedcomx familysearch

20/09 2016

3.0.0

3.0.0.0 https://github.com/FamilySearch/gedcomx-php

PHP libraries for GEDCOM X.

  Sources   Download

Apache-2.0

The Development Requires

sdk genealogy gedcomx familysearch

19/03 2015
18/03 2015