File Rs/Client/AncestryResultsState.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

<?php

namespace Gedcomx\Rs\Client;

use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\Util\AncestryTree;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * The AncestryResultsState exposes management functions for ancestry results.
 *
 * Class AncestryResultsState
 *
 * @package Gedcomx\Rs\Client
 */
class AncestryResultsState extends GedcomxApplicationState
{
    /**
     * Constructs a new ancestry 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\Rs\Client\AncestryResultsState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new AncestryResultsState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Gets the rel name for the current state instance.
     *
     * @return string
     */
    public function getSelfRel()
    {
        return Rel::ANCESTRY;
    }

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

        return new Gedcomx($json);
    }

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

    /**
     * Gets the tree represented by the REST API response.
     *
     * @return \Gedcomx\Rs\Client\Util\AncestryTree
     */
    public function getTree()
    {
        if ($this->getEntity()) {
            return new AncestryTree($this->getEntity());
        }

        return null;
    }

    /**
     * Reads the person at the specified one-based index number.
     *
     * @param                                          $ancestorNumber
     * @param \Gedcomx\Rs\Client\StateTransitionOption $option,...
     *
     * @return mixed|null
     */
    public function readPerson($ancestorNumber, StateTransitionOption $option = null)
    {
        $ancestor = $this->getTree()->getAncestor(ancestorNumber);
        if ($ancestor == null) {
            return null;
        }

        $selfLink = $ancestor->getPerson()->getLink(Rel::PERSON);
        if ($selfLink == null || $selfLink->getHref() == null) {
            $selfLink = $ancestor->getPerson()->getLink(Rel::SELF);
        }

        $personUri = null;
        if ($selfLink && $selfLink->getHref()) {
            $personUri = $selfLink->getHref();
        }
        if (!$personUri) {
            return null;
        }

        $request = $this->createAuthenticatedGedcomxRequest('GET', $personUri);

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

Namespaces

Classes

Interfaces

Exceptions