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
<?php
namespace Gedcomx\Rs\Client;
use Gedcomx\Gedcomx;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
/**
* The RecordsState exposes management functions for a collection of records.
*/
class RecordsState extends GedcomxApplicationState
{
/**
* Constructs a records 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\RecordsState
*/
protected function reconstruct(Request $request, Response $response)
{
return new RecordsState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
}
/**
* Gets the entity represented by this state (if applicable). Not all responses produce entities.
*
* @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 rel name for the current state instance.
*
* @return string
*/
public function getSelfRel()
{
return Rel::RECORDS;
}
}