gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • DefaultJsonSerialization
  • DefaultXMLSerialization
  • GedcomxFile
  • GedcomxFileEntry
  • GedcomxOutput
  • Manifest
  • ManifestAttribute

Interfaces

  • GedcomxEntryDeserializer
  • GedcomxEntrySerializer

Exceptions

  • GedcomxFileException

Class GedcomxFile

Class GedcomxFile

Namespace: Gedcomx\GedcomxFile
Package: Gedcomx\GedcomxFile
Located at GedcomxFile/GedcomxFile.php

Methods summary

public
# __construct( string $filepath, Gedcomx\GedcomxFile\GedcomxEntryDeserializer $deserializer = null )

Create a new instance of a GedcomxFile

Create a new instance of a GedcomxFile

Parameters

$filepath
The path to the .gedx file
$deserializer

The class to use for deserialization. Defaults to DefaultXMLSerialization

Throws

Gedcomx\GedcomxFile\GedcomxFileException
public Gedcomx\GedcomxFile\GedcomxFileEntry[]
# getEntries( )

Return the entries found in the archive

Return the entries found in the archive

Returns

Gedcomx\GedcomxFile\GedcomxFileEntry[]
public array
# getAttributes( )

Return attributes from the manifest file

Return attributes from the manifest file

Returns

array
public array
# getWarnings( )

Return any warnings generated during parsing

Return any warnings generated during parsing

Returns

array
public
# addAttribute( string $key, string $value )

Add an attribute to the list

Add an attribute to the list

Parameters

$key
$value
public string|null
# getAttribute( string $key )

Return the value of an attribute

Return the value of an attribute

Parameters

$key

Returns

string|null
public mixed
# readResource( Gedcomx\GedcomxFile\GedcomxFileEntry $entry )

Deserialize a GedcomX resource

Deserialize a GedcomX resource

Parameters

$entry

Returns

mixed
public
# close( )

Close the archive file.

Close the archive file.

public Gedcomx\GedcomxFile\GedcomxFileEntry
# readEntry( string $name )

Read an entry from the archive and look for manifest properties.

Read an entry from the archive and look for manifest properties.

Parameters

$name

Returns

Gedcomx\GedcomxFile\GedcomxFileEntry
gedcomx-php-client API documentation generated by ApiGen