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

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client;

use Gedcomx\Extensions\FamilySearch\FamilySearchPlatform;
use Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Helpers\FamilySearchRequest;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * The PersonMergeState exposes management functions for a person merge.
 *
 * Class PersonMergeState
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client
 */
class PersonMergeState extends FamilySearchCollectionState{
    /**
     * Clones the current state instance.
     *
     * @param \GuzzleHttp\Psr7\Request  $request
     * @param \GuzzleHttp\Psr7\Response $response
     *
     * @return \Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        /** @var \Gedcomx\Rs\Client\StateFactory $stateFactory */
        return new PersonMergeState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Gets the main data element represented by this state instance.
     *
     * @return object
     */
    protected function getScope()
    {
        return $this->getEntity();
    }

    /**
     * Gets the analysis of the current person merge.
     *
     * @return \Gedcomx\Extensions\FamilySearch\Platform\Tree\MergeAnalysis|null
     */
    public function getAnalysis()
    {
        if ($this->getEntity() != null && $this->getEntity()->getMergeAnalyses() != null) {
            $analysis = $this->getEntity()->getMergeAnalyses();
            if (count($analysis) > 0) {
                return $analysis[0];
            }
        }

        return null;
    }

    /**
     * If there is no 'Allow' header, it is allowed
     *
     * @returns boolean
     */
    public function isAllowed()
    {
        $header = $this->getResponse()->getHeader("Allow");
        if ($header == null) {
            return false;
        }

        $values = $header->toArray();
        return  count($values) > 0 && strpos(strtoupper($values[0]), 'POST') !== false;
    }

    /**
     * Reads the merge mirror for the current merge.
     *
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return PersonMergeState|null
     */
    public function readMergeMirror(StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::MERGE_MIRROR);
        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
        );
    }

    /**
     * Reads the survivor of the current merge.
     *
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\PersonState|null
     */
    public function readSurvivor(StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::PERSON);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedRequest('GET', $link->getHref());

        return $this->stateFactory->createState(
            'PersonState',
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Performs the specified merge operation.
     *
     * @param \Gedcomx\Extensions\FamilySearch\Platform\Tree\Merge $merge
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption     $option,...
     *
     * @return PersonMergeState
     */
    public function doMerge(Merge $merge, StateTransitionOption $option = null)
    {
        $entity = new FamilySearchPlatform();
        $entity->addMerge($merge);

        return $this->passOptionsTo('mergeEntity', array($entity), func_get_args());
    }

    /**
     * Performs the specified merges from FamilySearchPlatform::getMerges().
     *
     * @param \Gedcomx\Extensions\FamilySearch\FamilySearchPlatform $entity
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption      $option,...
     *
     * @return PersonMergeState
     */
    public function mergeEntity(FamilySearchPlatform $entity, StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('post', array($entity), func_get_args());
    }
}

Namespaces

Classes

Interfaces

Exceptions