File Extensions/FamilySearch/Rs/Client/FamilyTree/ChangeHistoryState.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

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree;

use Gedcomx\Atom\Entry;
use Gedcomx\Atom\Feed;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Helpers\FamilySearchRequest;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Rel;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Util\ChangeHistoryPage;
use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\Exception\GedcomxApplicationException;
use Gedcomx\Rs\Client\GedcomxApplicationState;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * Class ChangeHistoryState
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree
 *
 *         The ChangeHistoryState exposes management functions for a change history
 */
class ChangeHistoryState extends GedcomxApplicationState
{

    /**
     * Clones the current instance of ChangeHistoryState
     *
     * @param \GuzzleHttp\Psr7\Request  $request
     * @param \GuzzleHttp\Psr7\Response $response
     *
     * @return \Gedcomx\Extensions\FamilySearch\Rs\Client\FamilyTree\ChangeHistoryState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new ChangeHistoryState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Deserialize the returned data
     *
     * @return \Gedcomx\Atom\Feed
     */
    protected function loadEntity()
    {
        $json = json_decode($this->response->getBody(), true);

        return new Feed($json);
    }

    /**
     * Return the parsed entity
     *
     * @return \Gedcomx\Atom\Feed
     */
    protected function getScope()
    {
        return $this->getEntity();
    }

    /**
     * Gets the change history page represented by the current state instance.
     *
     * @return ChangeHistoryPage|null
     */
    public function getPage()
    {
        /** @var Feed $feed */
        $feed = $this->getEntity();
        return $feed == null ? null : new ChangeHistoryPage($feed);
    }

    /**
     * Restores the specified change if it had been reverted.
     *
     * @param \Gedcomx\Atom\Entry                              $change
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @throws \Gedcomx\Rs\Client\Exception\GedcomxApplicationException
     * @return ChangeHistoryState | null
     */
    public function restoreChange(Entry $change, StateTransitionOption $option = null)
    {
        $link = $change->getLink(Rel::RESTORE);
        if ($link == null || $link->getHref() == null) {
            throw new GedcomxApplicationException("Unrestorable change: " . $change->getId());
        }

        $request = $this->createAuthenticatedRequest('POST', $link->getHref(), FamilySearchRequest::getMediaTypes());

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

}

Namespaces

Classes

Interfaces

Exceptions