File Rs/Client/PersonSearchResultsState.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 193 194 195 196 197 198 199 200 201 202 203 204

<?php

namespace Gedcomx\Rs\Client;

use Gedcomx\Atom\Entry;
use Gedcomx\Atom\Feed;
use Gedcomx\Conclusion\Person;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

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

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

    /**
     * Gets the main data element represented by this state instance.
     *
     * @return \Gedcomx\Atom\Feed
     */
    protected function getScope()
    {
        return $this->getResults();
    }

    /**
     * Gets the search results from the atom feed response.
     *
     * @return Feed
     */
    public function getResults()
    {
        return $this->getEntity();
    }

    /**
     * Reads the person from the specified person model.
     *
     * @param \Gedcomx\Conclusion\Person                       $person
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return PersonState|null
     */
    public function readPersonFromConclusion( Person $person, StateTransitionOption $option = null)
    {
        $link = $person->getLink(Rel::PERSON);
        if ($link === null) {
            $link = $person->getLink(Rel::SELF);
        }
        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 the person from the specified atom feed entry.
     *
     * @param \Gedcomx\Atom\Entry                              $person
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return PersonState|null
     */
    public function readPersonFromEntry( Entry $person, StateTransitionOption $option = null)
    {
        $link = $person->getLink(Rel::PERSON);
        if ($link === null) {
            $link = $person->getLink(Rel::SELF);
        }
        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 the person record from the specified atom feed entry.
     *
     * @param \Gedcomx\Atom\Entry                              $person
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return RecordState|null
     */
    public function readRecord(Entry $person, StateTransitionOption $option = null)
    {
        $link = $person->getLink(Rel::RECORD);
        if ($link === null) {
            $link = $person->getLink(Rel::SELF);
        }
        if ($link === null || $link->getHref() === null) {
            return null;
        }

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

    /**
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return GedcomxApplicationState The next page.
     */
    public function readNextPage(StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('readPage', array(Rel::NEXT), func_get_args());
    }

    /**
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return GedcomxApplicationState The previous page.
     */
    public function readPreviousPage(StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('readPage', array(Rel::PREVIOUS), func_get_args());
    }

    /**
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return GedcomxApplicationState The first page.
     */
    public function readFirstPage(StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('readPage', array(Rel::FIRST), func_get_args());

    }

    /**
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return GedcomxApplicationState the last page.
     */
    public function readLastPage(StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('readPage', array(Rel::LAST), func_get_args());
    }
}

Namespaces

Classes

Interfaces

Exceptions