File Extensions/FamilySearch/Rs/Client/FamilySearchPlaces.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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226

<?php 

namespace Gedcomx\Extensions\FamilySearch\Rs\Client;

use Gedcomx\Extensions\FamilySearch\Rs\Client\Helpers\FamilySearchRequest;
use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\Exception\GedcomxInvalidQueryParameter;
use Gedcomx\Rs\Client\GedcomxApplicationState;
use Gedcomx\Rs\Client\GedcomxSearchQuery;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use Gedcomx\Rs\Client\Util\GedcomxPlaceSearchQueryBuilder;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * The FamilySearchPlaces is a collection of FamilySearch places and exposes management of those places.
 *
 * Class FamilySearchPlaces
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client
 */
class FamilySearchPlaces extends FamilySearchCollectionState
{
    /**
     * Clones the current state instance.
     *
     * @param \GuzzleHttp\Psr7\Request  $request
     * @param \GuzzleHttp\Psr7\Response $response
     *
     * @return \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new FamilySearchPlaces($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Read the list of place type groups
     *
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\VocabElementListState|null the list of place type groups
     */
    public function readPlaceTypeGroups(StateTransitionOption $option = null) {
        return $this->passOptionsTo('readPlaceElementList', array(Rel::PLACE_TYPE_GROUPS), func_get_args());
    }

    /**
     * Read the list of place types
     *
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\VocabElementListState the list of place types
     */
    public function readPlaceTypes(StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('readPlaceElementList', array(Rel::PLACE_TYPES), func_get_args());
    }

    /**
     * Read the VocabElementList from the given path
     *
     * @param string                                           $path
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\VocabElementListState|null
     */
    protected function readPlaceElementList($path, StateTransitionOption $option = null)
    {
        $link = $this->getLink($path);
        if (null == $link || null == $link->getTemplate()) {
            return null;
        }

        $uri = array(
            $link->getTemplate(),
            array()
        );

        $request = $this->createAuthenticatedRequest('GET', $uri, ['Accept' => Gedcomx::LD_JSON_TYPE]);
        return $this->stateFactory->createState(
            'VocabElementListState',
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Read the place type group with the given id
     *
     * @param string                                           $id
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\VocabElementListState|null the place type group with the given id
     */
    public function readPlaceTypeGroupById($id, StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::PLACE_TYPE_GROUP);
        if ($link == null || $link->getTemplate() == null) {
            return null;
        }

        $uri = array(
            $link->getTemplate(),
            array(
                'ptgid' => $id
            )
        );

        $request = $this->createAuthenticatedRequest('GET', $uri, ['Accept' => Gedcomx::LD_JSON_TYPE]);
        return $this->stateFactory->createState(
            'VocabElementListState',
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Read the place type with the given id
     *
     * @param string                                           $id
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\VocabElementState|null the place type group with the given id
     */
    public function readPlaceTypeById($id, StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::PLACE_TYPE);
        if ($link == null || $link->getTemplate() == null) {
            return null;
        }

        $uri = array(
            $link->getTemplate(),
            array(
                "ptid" => $id
            )
        );

        $request = $this->createAuthenticatedRequest('GET', $uri, ['Accept' => Gedcomx::LD_JSON_TYPE]);
        return $this->stateFactory->createState(
            'VocabElementState',
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Return the PlaceGroup with the given id
     *
     * @param string                                           $id
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return \Gedcomx\Rs\Client\PlaceGroupState|null
     */
    public function readPlaceGroupById($id, StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::PLACE_GROUP);
        if ($link == null || $link->getTemplate() == null) {
            return null;
        }

        $uri = array(
            $link->getTemplate(),
            array(
                "pgid" => $id
            )
        );

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

    /**
     * Searches for places based off the specified query.
     *
     * @param GedcomxSearchQuery|string $query
     * @param StateTransitionOption     $option,...
     *
     * @throws \Gedcomx\Rs\Client\Exception\GedcomxInvalidQueryParameter
     * @return \Gedcomx\Rs\Client\PlaceSearchResultsState|null
     */
    public function searchForPlaces($query, StateTransitionOption $option = null )
    {
        $searchLink = $this->getLink(Rel::PLACE_SEARCH);
        if ($searchLink === null || $searchLink->getTemplate() === null) {
            return null;
        }
        if ($query instanceof GedcomxPlaceSearchQueryBuilder) {
            $queryString = $query->build();
        } elseif (is_string($query)) {
            $queryString = $query;
        } else {
            throw new GedcomxInvalidQueryParameter($query);
        }

        $uri = array(
            $searchLink->getTemplate(),
            array(
                "q" => $queryString
            )
        );

        $request = $this->createAuthenticatedFeedRequest("GET", $uri, ['Accept' => Gedcomx::ATOM_JSON_MEDIA_TYPE]);
        return $this->stateFactory->createState(
            "PlaceSearchResultsState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

}

Namespaces

Classes

Interfaces

Exceptions