https://github.com/liberu-genealogy/php-gedcom

Gedcom reading and writing for PHP 8.3
https://github.com/liberu-genealogy/php-gedcom

gedcom gedcom-parser gedcom-parsing laravel laravel10 php php8

Last synced: 1 day ago
JSON representation

Gedcom reading and writing for PHP 8.3

• Host: GitHub
• URL: https://github.com/liberu-genealogy/php-gedcom
• Owner: liberu-genealogy
• License: mit
• Created: 2023-05-14T19:46:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-26T14:15:18.000Z (about 1 month ago)
• Last Synced: 2024-09-23T16:33:15.504Z (2 days ago)
• Topics: gedcom, gedcom-parser, gedcom-parsing, laravel, laravel10, php, php8
• Language: PHP
• Homepage: https://www.liberu.co.uk
• Size: 1.12 MB
• Stars: 74
• Watchers: 4
• Forks: 41
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# php-gedcom

 ![Latest Stable Version](https://img.shields.io/github/release/liberu-genealogy/php-gedcom.svg)

[![Tests](https://github.com/liberu-genealogy/php-gedcom/actions/workflows/run-tests.yml/badge.svg)](https://github.com/liberu-genealogy/php-gedcom/actions/workflows/run-tests.yml)

## Requirements

* php-gedcom 1.0+ requires PHP 8.3 (or later).

## Installation

There are two ways of installing php-gedcom.

### Composer

To install php-gedcom in your project using composer, simply add the following require line to your project's `composer.json` file:

    {

        "require": {

            "liberu-genealogy/php-gedcom": "2.0.*"

        }

    }

### Download and __autoload

If you are not using composer, you can download an archive of the source from GitHub and extract it into your project. You'll need to setup an autoloader for the files, unless you go through the painstaking process if requiring all the needed files one-by-one. Something like the following should suffice:

```php

spl_autoload_register(function ($class) {

    $pathToGedcom = __DIR__ . '/library/'; // TODO FIXME

    if (!substr(ltrim($class, '\\'), 0, 7) == 'Gedcom\\') {

        return;

    }

    $class = str_replace('\\', DIRECTORY_SEPARATOR, $class) . '.php';

    if (file_exists($pathToGedcom . $class)) {

        require_once($pathToGedcom . $class);

    }

});

```

### Usage

To parse a GEDCOM file and load it into a collection of PHP Objects, simply instantiate a new Parser object and pass it the file name to parse. The resulting Gedcom object will contain all the information stored within the supplied GEDCOM file:

```php

$parser = new \Gedcom\Parser();

$gedcom = $parser->parse('tmp.ged');

foreach ($gedcom->getIndi() as $individual) {

    $names = $individual->getName();

    if (!empty($names)) {

        $name = reset($names); // Get the first name object from the array

        echo $individual->getId() . ': ' . $name->getSurn() . ', ' . $name->getGivn() . PHP_EOL;

    }

}

```

## Contributing 

Pull requests are welcome, as are issues.

## License

MIT License (see License.md). This means you must retain the copyright and permission notice is all copies, or substantial portions of this software. 

## Contributors