File Extensions/FamilySearch/Rs/Client/PersonMatchResultsState.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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client;

use Gedcomx\Atom\Entry;
use Gedcomx\Conclusion\Identifier;
use Gedcomx\Conclusion\Person;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Helpers\FamilySearchRequest;
use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use Gedcomx\Rs\Client\PersonSearchResultsState;
use Gedcomx\Rs\Client\PersonState;
use Gedcomx\Rs\Client\StateFactory;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Gedcomx\Types\IdentifierType;

/**
 * The PersonMatchResultsState exposes management functions for a person match results.
 *
 * Class PersonMatchResultsState
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client
 */
class PersonMatchResultsState extends PersonSearchResultsState
{
    /**
     * Constructs a new person match results state using the specified client, request, response, access token, and
     * state factory.
     * @param \GuzzleHttp\Client             $client
     * @param \GuzzleHttp\Psr7\Request    $request
     * @param \GuzzleHttp\Psr7\Response   $response
     * @param string                          $accessToken
     * @param \Gedcomx\Rs\Client\StateFactory $stateFactory
     */
    function __construct(Client $client, Request $request, Response $response, $accessToken, StateFactory $stateFactory)
    {
        parent::__construct($client, $request, $response, $accessToken, $stateFactory);
    }

    /**
     * Clones the current state instance.
     *
     * @param \GuzzleHttp\Psr7\Request  $request
     * @param \GuzzleHttp\Psr7\Response $response
     *
     * @return \Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new PersonMatchResultsState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Reads the current person for these potential match results.
     *
     * @param StateTransitionOption $option,...
     *
     * @return PersonState
     */
    public function readPerson(StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::PERSON);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedGedcomxRequest("GET", $link->getHref());
        return $this->stateFactory->createState(
            "PersonState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Reads merge options for the specified search result entry.
     *
     * @param Entry $entry
     * @param StateTransitionOption $options
     * @return PersonMergeState
     */
    public function readMergeOptions(Entry $entry, StateTransitionOption $options = null)
    {
        $link = $entry->getLink(Rel::MERGE);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedRequest('OPTIONS', $link->getHref(), FamilySearchRequest::getMediaTypes());
        return $this->stateFactory->createState(
            "PersonMergeState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Creates a merge analysis for the current person and the potential duplicate person specified by the search result
     * entry.
     *
     * @param Entry $entry
     * @param StateTransitionOption $options
     * @return PersonMergeState
     */
    public function readMergeAnalysis(Entry $entry, StateTransitionOption $options = null)
    {
        $link = $entry->getLink(Rel::MERGE);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedRequest('GET', $link->getHref(), FamilySearchRequest::getMediaTypes());
        return $this->stateFactory->createState(
            "PersonMergeState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Declares the specified search result entry as not a match for the current person.
     *
     * @param Entry $entry
     * @param StateTransitionOption $options
     * @return PersonNonMatchesState
     */
    public function addNonMatch(Entry $entry, StateTransitionOption $options = null)
    {
        $link = $this->getLink(Rel::NOT_A_MATCHES);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $entity = new Gedcomx();
        $person = new Person();
        $person->setId($entry->getId());
        $entity->addPerson($person);
        $request = $this->createAuthenticatedRequest('POST', $link->getHref(), FamilySearchRequest::getMediaTypes(), null, $entity->toJson());
        return $this->stateFactory->createState(
            "PersonNonMatchesState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Declares the match status for the current person the specified search result entry.
     *
     * @param Entry $entry
     * @param string $status
     * @param StateTransitionOption $options
     * @return PersonMatchResultsState
     */
    public function updateMatchStatus(Entry $entry, $status, StateTransitionOption $options = null)
    {
        $updateStatusUri = $this->getSelfUri();
        $entity = new Gedcomx();
        $person = new Person();
        $id = new Identifier();
        $id->setType(IdentifierType::PERSISTENT);
        $entryPersonIdentifiers = $entry->getContent()->getGedcomx()->getPersons()[0]->getIdentifiers();
        $entryPersistentIdentifier = null;
        foreach($entryPersonIdentifiers as $epi) {
            if($epi->getType() === IdentifierType::PERSISTENT) {
                $id->setValue($epi->getValue());
                break;
            }
        }
        $person->setIdentifiers(array($id));
        $entity->setPersons(array($person));
        
        $request = $this->createAuthenticatedGedcomxRequest("POST", $updateStatusUri, [], null, $entity->toJson());
        $request = $request->withoutHeader("Accept");
        return $this->stateFactory->createState(
            "PersonMatchResultsState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }
}

Namespaces

Classes

Interfaces

Exceptions