gedcomx-php
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • ChangeInfo
  • ChangeObjectModifier
  • ChangeObjectType
  • ChangeOperation
  • ChildAndParentsRelationship
  • DiscussionReference
  • MatchInfo
  • MatchStatus
  • Merge
  • MergeAnalysis
  • MergeConflict

Class MatchInfo

Class MatchInfo

Namespace: Gedcomx\Extensions\FamilySearch\Platform\Tree
Package: Gedcomx\Extensions\FamilySearch\Platform\Tree
Located at Extensions/FamilySearch/Platform/Tree/MatchInfo.php

Methods summary

public
# __construct( mixed $o = null )

Constructs a MatchInfo from a (parsed) JSON hash

Constructs a MatchInfo from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.

Throws

Exception
public string
# getStatus( )

The way this match has been resolved.

The way this match has been resolved.

Returns

string
public
# setStatus( string $status )

The way this match has been resolved.

The way this match has been resolved.

Parameters

$status
public string
# getCollection( )

The collection in which this match was found.

The collection in which this match was found.

Returns

string
public
# setCollection( string $collection )

The collection in which this match was found.

The collection in which this match was found.

Parameters

$collection
public array
# toArray( )

Returns the associative array for this MatchInfo

Returns the associative array for this MatchInfo

Returns

array
public string
# toJson( )

Returns the JSON string for this MatchInfo

Returns the JSON string for this MatchInfo

Returns

string
public
# initFromArray( array $o )

Initializes this MatchInfo from an associative array

Initializes this MatchInfo from an associative array

Parameters

$o
public
# initFromReader( XMLReader $xml )

Initializes this MatchInfo from an XML reader.

Initializes this MatchInfo from an XML reader.

Parameters

$xml
The reader to use to initialize this object.
public
# toXml( XMLWriter $writer, boolean $includeNamespaces = true )

Writes this MatchInfo to an XML writer.

Writes this MatchInfo to an XML writer.

Parameters

$writer
The XML writer.
$includeNamespaces
Whether to write out the namespaces in the element.
public
# writeXmlContents( XMLWriter $writer )

Writes the contents of this MatchInfo to an XML writer. The startElement is expected to be already provided.

Writes the contents of this MatchInfo to an XML writer. The startElement is expected to be already provided.

Parameters

$writer
The XML writer.
gedcomx-php API documentation generated by ApiGen