File Extensions/FamilySearch/Rs/Client/PersonNonMatchesState.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

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client;

use Gedcomx\Conclusion\Person;
use Gedcomx\Extensions\FamilySearch\FamilySearchPlatform;
use Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState;
use Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Helpers\FamilySearchRequest;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use Gedcomx\Rs\Client\PersonState;
use Gedcomx\Rs\Client\Util\HttpStatus;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * The PersonNonMatchesState exposes management functions for person non matches.
 *
 * Class PersonNonMatchesState
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client
 */
class PersonNonMatchesState extends PersonState
{
    /**
     * Constructs a new person non matches 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\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreeStateFactory $stateFactory
     */
    public function __construct(Client $client, Request $request, Response $response, $accessToken, FamilyTreeStateFactory $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\FamilyTree\FamilyTreePersonState
     */
    protected function  reconstruct(Request $request, Response $response)
    {
        /** @var \Gedcomx\Rs\Client\StateFactory $stateFactory */
        return new FamilyTreePersonState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Loads the entity from the REST API response if the response should have data.
     *
     * @return \Gedcomx\Extensions\FamilySearch\FamilySearchPlatform|null
     */
    protected function loadEntityConditionally()
    {
        if ($this->request->getMethod() =='GET'
            && ($this->response->getStatusCode() == HttpStatus::OK || $this->response->getStatusCode() == HttpStatus::GONE)
            || $this->response->getStatusCode() == HttpStatus::PRECONDITION_FAILED
        ) {
            return $this->loadEntity();
        } else {
            return null;
        }
    }

    /**
     * Returns the entity from the REST API response.
     *
     * @return \Gedcomx\Extensions\FamilySearch\FamilySearchPlatform
     */
    protected function loadEntity()
    {
        $json = json_decode($this->response->getBody(), true);

        return new FamilySearchPlatform($json);
    }

    /**
     * Adds a person as a non match to this collection.
     *
     * @param Person $person
     * @param StateTransitionOption $option,...
     *
     * @return PersonNonMatchesState|null
     */
    public function addNonMatch(Person $person, StateTransitionOption $option = null)
    {
        $entity = new FamilySearchPlatform();
        $entity->setPersons(array($person));
        return $this->passOptionsTo('post', array($entity), func_get_args());
    }

    /**
     * Removes the declared non match person from this collection.
     *
     * @param \Gedcomx\Conclusion\Person                       $nonMatch
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return mixed|null
     */
    public function removeNonMatch(Person $nonMatch, StateTransitionOption $option = null)
    {
        $link = $nonMatch->getLink(Rel::NOT_A_MATCHES);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

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

Namespaces

Classes

Interfaces

Exceptions