File Rs/Client/CollectionsState.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

<?php


namespace Gedcomx\Rs\Client;

use Gedcomx\Gedcomx;
use Gedcomx\Records\Collection;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use Gedcomx\Source\SourceDescription;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use Symfony\Component\Yaml\Exception\RuntimeException;

/**
 * Class CollectionsState
 * @package Gedcomx\Rs\Client
 * The CollectionState is a collection of resources and exposes management of those resources.
 */

class CollectionsState extends GedcomxApplicationState
{
    /**
     * Constructs a new collections 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\CollectionsState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new CollectionsState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Returns the entity from the REST API response.
     *
     * @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 \Gedcomx\Records\Collection[]|null
     */
    protected function getScope()
    {
        return $this->getCollections();
    }

    /**
     * Gets the collections represented by the current state instance.
     *
     * @return Collection[]|null
     */
    public function getCollections()
    {
        if ($this->entity) {
            return $this->entity->getCollections();
        }

        return null;
    }

    /**
     * Gets the source descriptions represented by the current state instance.
     *
     * @return SourceDescription[]|null
     */
    public function getSourceDescriptions()
    {
        if ($this->entity) {
            return $this->entity->getSourceDescriptions();
        }

        return null;
    }

    /**
     * Reads the specified collection.
     *
     * @param Collection|SourceDescription|null $collection
     * @param StateTransitionOption $options,...
     * @return CollectionState|null The collection that contains these collections.
     */
    public function readCollection($collection, StateTransitionOption $options = null)
    {
        $link = null;
        if ($collection === null){
            $link = $this->getLink(Rel::COLLECTION);
            if ($link == null || $link->getHref() == null)
            {
                return null;
            }
            $link = $link->getHref();
        }else if ($collection instanceof Collection) {
            $link = $collection->getLink("self");
            if ($link == null || $link->getHref() == null) {
                return null;
            }
            $link = $link->getHref();
        } else if ($collection instanceof SourceDescription){
            $link = $collection->getAbout();
            if (!$link){
                return null;
            }
        }

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

    /**
     * Updates the specified collection.
     *
     * @param Collection $collection
     * @param StateTransitionOption $options
     * @return CollectionState|null
     */
    public function updateCollection(Collection $collection, StateTransitionOption $options = null)
    {
        $link = $collection->getLink("self");
        if ($link == null || $link->getHref() == null) {
            return null;
        }

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

    /**
     * Adds a collection to the collection by this state instance.
     *
     * @param Collection $collection the collection to add to these collections.
     * @return CollectionState|null
     */
    public function addCollection($collection)
    {
        $link = $this->getLink("self");
        $href = $link === null ? null : $link->getHref() == null ? null : $link->getHref();
        $href = $href === null ? $this->getUri() : $href;

        $request = $this->createAuthenticatedGedcomxRequest("POST", $href);
        /** @var CollectionState $result */
        $result = $this->stateFactory->createState(
            "CollectionState",
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );

        return $result->ifSuccessful();
    }
}

Namespaces

Classes

Interfaces

Exceptions