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 ChangeInfo

Class ChangeInfo

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

Methods summary

public
# __construct( mixed $o = null )

Constructs a ChangeInfo from a (parsed) JSON hash

Constructs a ChangeInfo from a (parsed) JSON hash

Parameters

$o
Either an array (JSON) or an XMLReader.
public string
# getObjectModifier( )

An optional modifier for the object to which the operation applies.

An optional modifier for the object to which the operation applies.

Returns

string
public
# setObjectModifier( string $objectModifier )

An optional modifier for the object to which the operation applies.

An optional modifier for the object to which the operation applies.

Parameters

$objectModifier
public string
# getOperation( )

The operation of the change.

The operation of the change.

Returns

string
public
# setOperation( string $operation )

The operation of the change.

The operation of the change.

Parameters

$operation
public string
# getReason( )

The reason for the change.

The reason for the change.

Returns

string
public
# setReason( string $reason )

The reason for the change.

The reason for the change.

Parameters

$reason
public string
# getObjectType( )

The type of the object to which the operation applies.

The type of the object to which the operation applies.

Returns

string
public
# setObjectType( string $objectType )

The type of the object to which the operation applies.

The type of the object to which the operation applies.

Parameters

$objectType
public Gedcomx\Common\ResourceReference
# getOriginal( )

The subject representing the original value(s) that existed before the change.

The subject representing the original value(s) that existed before the change.

Returns

Gedcomx\Common\ResourceReference
public
# setOriginal( Gedcomx\Common\ResourceReference $original )

The subject representing the original value(s) that existed before the change.

The subject representing the original value(s) that existed before the change.

Parameters

$original
public Gedcomx\Common\ResourceReference
# getParent( )

The parent change that triggered, caused, or included this change.

The parent change that triggered, caused, or included this change.

Returns

Gedcomx\Common\ResourceReference
public
# setParent( Gedcomx\Common\ResourceReference $parent )

The parent change that triggered, caused, or included this change.

The parent change that triggered, caused, or included this change.

Parameters

$parent
public Gedcomx\Common\ResourceReference
# getRemoved( )

The subject representing the removed value(s) that existed before the change.

The subject representing the removed value(s) that existed before the change.

Returns

Gedcomx\Common\ResourceReference
public
# setRemoved( Gedcomx\Common\ResourceReference $removed )

The subject representing the removed value(s) that existed before the change.

The subject representing the removed value(s) that existed before the change.

Parameters

$removed
public Gedcomx\Common\ResourceReference
# getResulting( )

The subject representing the result of the change.

The subject representing the result of the change.

Returns

Gedcomx\Common\ResourceReference
public
# setResulting( Gedcomx\Common\ResourceReference $resulting )

The subject representing the result of the change.

The subject representing the result of the change.

Parameters

$resulting
public array
# toArray( )

Returns the associative array for this ChangeInfo

Returns the associative array for this ChangeInfo

Returns

array
public string
# toJson( )

Returns the JSON string for this ChangeInfo

Returns the JSON string for this ChangeInfo

Returns

string
public
# initFromArray( array $o )

Initializes this ChangeInfo from an associative array

Initializes this ChangeInfo from an associative array

Parameters

$o
public
# initFromReader( XMLReader $xml )

Initializes this ChangeInfo from an XML reader.

Initializes this ChangeInfo from an XML reader.

Parameters

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

Writes this ChangeInfo to an XML writer.

Writes this ChangeInfo 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 ChangeInfo to an XML writer. The startElement is expected to be already provided.

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

Parameters

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