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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 <?php
namespace Gedcomx\Extensions\FamilySearch\Rs\Client;
use Gedcomx\Extensions\FamilySearch\FamilySearchPlatform;
use Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\FamilyTreePersonState;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Memories\FamilySearchMemories;
use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\GedcomxApplicationState;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Util\ExperimentsFilter;
use Gedcomx\Rs\Client\PlaceDescriptionsState;
use Gedcomx\Rs\Client\PlaceGroupState;
use Gedcomx\Rs\Client\PlaceSearchResultsState;
use Gedcomx\Rs\Client\StateFactory;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
/**
* The state factory is responsible for instantiating state classes from REST API responses.
*
* Class FamilySearchStateFactory
*
* @package Gedcomx\Extensions\FamilySearch\Rs\Client
*/
class FamilySearchStateFactory extends StateFactory
{
/**
* The default production environment URI for the places collection.
*/
const PLACES_URI = "https://api.familysearch.org/platform/collections/places";
/**
* The default integration environment URI for the places collection.
*/
const PLACES_INTEGRATION_URI = "https://integration.familysearch.org/platform/collections/places";
/**
* The default production environment URI for the memories collection.
*/
const MEMORIES_URI = "https://api.familysearch.org/platform/collections/memories";
/**
* The default integration environment URI for the memories collection.
*/
const MEMORIES_INTEGRATION_URI = "https://integration.familysearch.org/platform/collections/memories";
/**
* Creates a new FamilySearch collection state from the specified parameters. Since a response is provided as a parameter, a REST API request will not be invoked.
*
* @param string $uri
* @param string $method The method.
* @param \GuzzleHttp\Client $client The client to use.
*
* @return FamilySearchCollectionState The collection state.
*/
public function newCollectionState($uri = null, $method = "GET", Client $client = null)
{
if (!$client) {
$client = $this->defaultClient();
}
if ($uri == null) {
$uri = $this->production ? self::PRODUCTION_URI : self::INTEGRATION_URI;
}
/** @var Request $request */
$request = new Request($method, $uri, ['Accept' => FamilySearchPlatform::JSON_MEDIA_TYPE]);
return new FamilySearchCollectionState($client, $request, GedcomxApplicationState::send($client, $request), null, $this);
}
/**
* Create a new places state with the given URI
*
* @param string $uri
* @param string $method
* @param Client $client
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces
*/
public function newPlacesState($uri = null, $method = "GET", Client $client = null)
{
if (!$client) {
$client = $this->defaultClient();
}
if ($uri == null) {
$uri = $this->production ? self::PLACES_URI : self::PLACES_INTEGRATION_URI;
}
/** @var Request $request */
$request = new Request($method, $uri, ['Accept' => Gedcomx::JSON_MEDIA_TYPE]);
return new FamilySearchPlaces($client, $request, GedcomxApplicationState::send($client, $request), null, $this);
}
/**
* Create a new memories state
*
* @param null $uri
* @param string $method
* @param Client $client
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\Memories\FamilySearchMemories
*/
public function newMemoriesState($uri = null, $method = "GET", Client $client = null)
{
if (!$client) {
$client = $this->defaultClient();
}
if ($uri == null) {
$uri = $this->production ? self::MEMORIES_URI : self::MEMORIES_INTEGRATION_URI;
}
/** @var Request $request */
$request = new Request($method, $uri, ['Accept' => Gedcomx::JSON_MEDIA_TYPE]);
return new FamilySearchMemories($client, $request, GedcomxApplicationState::send($client, $request), null, $this);
}
/**
* Builds a new person state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionsState
*/
protected function buildPersonState(Client $client, Request $request, Response $response, $accessToken)
{
return new FamilyTreePersonState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new discussions state from the specified paramters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionsState
*/
protected function buildDiscussionsState(Client $client, Request $request, Response $response, $accessToken)
{
return new DiscussionsState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new discussion state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\DiscussionState
*/
protected function buildDiscussionState(Client $client, Request $request, Response $response, $accessToken)
{
return new DiscussionState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new user state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\UserState
*/
protected function buildUserState(Client $client, Request $request, Response $response, $accessToken)
{
return new UserState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new user history state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\UserHistoryState
*/
protected function buildUserHistoryState(Client $client, Request $request, Response $response, $accessToken)
{
return new UserHistoryState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new person merge state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMergeState
*/
protected function buildPersonMergeState(Client $client, Request $request, Response $response, $accessToken)
{
return new PersonMergeState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new person match results state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\PersonMatchResultsState
*/
protected function buildPersonMatchResultsState(Client $client, Request $request, Response $response, $accessToken)
{
return new PersonMatchResultsState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new source description state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchSourceDescriptionState
*/
protected function buildSourceDescriptionState(Client $client, Request $request, Response $response, $accessToken)
{
return new FamilySearchSourceDescriptionState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new person non-matches state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\PersonNonMatchesState
*/
protected function buildPersonNonMatchesState(Client $client, Request $request, Response $response, $accessToken)
{
return new PersonNonMatchesState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new place search results state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Rs\Client\PlaceSearchResultsState
*/
protected function buildPlaceSearchResultsState(Client $client, Request $request, Response $response, $accessToken)
{
return new PlaceSearchResultsState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new place state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilySearchPlaces
*/
protected function buildPlaceState(Client $client, Request $request, Response $response, $accessToken)
{
return new FamilySearchPlaces($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new place description state from the specified parameters.
*
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Rs\Client\PlaceDescriptionState
*/
protected function buildPlaceDescriptionState(Client $client, Request $request, Response $response, $accessToken)
{
return new FamilySearchPlaceDescriptionState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new place descriptions state from the specified parameters.
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Rs\Client\PlaceDescriptionsState
*/
protected function buildPlaceDescriptionsState(Client $client, Request $request, Response $response, $accessToken)
{
return new PlaceDescriptionsState($client, $request, $response, $accessToken, $this);
}
/**
* Builds a new place group state from the specified parameters.
* @param \GuzzleHttp\Client $client
* @param \GuzzleHttp\Psr7\Request $request
* @param \GuzzleHttp\Psr7\Response $response
* @param string $accessToken The access token for this session
*
* @return \Gedcomx\Rs\Client\PlaceDescriptionsState
*/
protected function buildPlaceGroupState(Client $client, Request $request, Response $response, $accessToken)
{
return new PlaceGroupState($client, $request, $response, $accessToken, $this);
}
}