File Extensions/FamilySearch/Rs/Client/Util/ChangeEntry.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client\Util;

use Gedcomx\Atom\Entry;
use Gedcomx\Extensions\FamilySearch\Platform\Tree\ChangeInfo;
use Gedcomx\Extensions\FamilySearch\Rt\FamilySearchPlatformLocalReferenceResolver;

/**
 * Represents a historical record of some operation performed (such as deleting a person).
 *
 * Class ChangeEntry
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client\Util
 */
class ChangeEntry extends Entry
{
    /** @var  $entry Entry */
    private $entry;
    /** @var  $changeInfo ChangeInfo */
    private $changeInfo;

    /**
     * Constructs a new change entry using the specified atom feed entry.
     *
     * @param \Gedcomx\Atom\Entry $entry
     */
    public function __construct(Entry $entry)
    {
        $this->entry = $entry;
        $this->changeInfo = $this->entry->findExtensionOfType('Gedcomx\Extensions\FamilySearch\Platform\Tree\ChangeInfo');
    }

    /**
     * Gets the change information associated with this change.
     *
     * @return \Gedcomx\Extensions\FamilySearch\Platform\Tree\ChangeInfo|mixed
     */
    public function getChangeInfo()
    {
        return $this->changeInfo;
    }

    /**
     * Gets the atom entry associated with this change.
     *
     * @return \Gedcomx\Atom\Entry
     */
    public function getEntry()
    {
        return $this->entry;
    }

    /**
     * Gets the change operation associated with this change (if available).
     *
     * @return null|string
     */
    public function getOperation()
    {
        return $this->changeInfo == null ? null : $this->changeInfo->getOperation();
    }

    /**
     * Gets the change object type associated with this change (if available).
     *
     * @return null|string
     */
    public function getObjectType()
    {
        return $this->changeInfo == null ? null : $this->changeInfo->getObjectType();
    }

    /**
     * Gets the change object modifier associated with this change (if available).
     *
     * @return null|string
     */
    public function getObjectModifier()
    {
        return $this->changeInfo == null ? null : $this->changeInfo->getObjectModifier();
    }

    /**
     * Gets the reason this change was performed (if available).
     *
     * @return null|string
     */
    public function getReason()
    {
        return $this->changeInfo == null ? null : $this->changeInfo->getReason();
    }

    /**
     * Gets the original value from before the change.
     *
     * @return null
     */
    public function getOriginalValue()
    {
        $changeInfo = $this->getChangeInfo();
        if ($changeInfo != null && $this->getEntry()->getContent() != null && $this->getEntry()->getContent()->getGedcomx() != null) {
            $original = $changeInfo->getOriginal();
            if ($original != null) {
                return FamilySearchPlatformLocalReferenceResolver::resolveByRef($original, $this->getEntry()->getContent()->getGedcomx());
            }
        }

        return null;
    }

    /**
     * Gets the resulting value from after the change.
     *
     * @return null
     */
    public function getResultingValue()
    {
        $changeInfo = $this->getChangeInfo();
        if ($changeInfo != null && $this->getEntry()->getContent() != null && $this->getEntry()->getContent()->getGedcomx() != null) {
            $resulting = $changeInfo->getResulting();
            if ($resulting != null) {
                return FamilySearchPlatformLocalReferenceResolver::resolveByRef($resulting, $this->getEntry()->getContent()->getGedcomx());
            }
        }

        return null;
    }

    /**
     * Gets the value that was removed by the change.
     *
     * @return null
     */
    public function getRemovedValue()
    {
        $changeInfo = $this->getChangeInfo();
        if ($changeInfo != null && $this->getEntry()->getContent() != null && $this->getEntry()->getContent()->getGedcomx() != null) {
            $removed = $changeInfo->getRemoved();
            if ($removed != null) {
                return FamilySearchPlatformLocalReferenceResolver::resolveByRef($removed, $this->getEntry()->getContent()->getGedcomx());
            }
        }

        return null;
    }
}

Namespaces

Classes

Interfaces

Exceptions