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

<?php

namespace Gedcomx\Extensions\FamilySearch\Rs\Client;

use Gedcomx\Extensions\FamilySearch\FamilySearchPlatform;
use Gedcomx\Extensions\FamilySearch\Platform\Discussions\Comment;
use Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion;
use Gedcomx\Extensions\FamilySearch\Rs\Client\Helpers\FamilySearchRequest;
use Gedcomx\Links\Link;
use Gedcomx\Records\Collection;
use Gedcomx\Rs\Client\Exception\GedcomxApplicationException;
use Gedcomx\Rs\Client\GedcomxApplicationState;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * The DiscussionState exposes management functions for a discussion.
 *
 * Class DiscussionState
 *
 * @package Gedcomx\Extensions\FamilySearch\Rs\Client
 */
class DiscussionState extends GedcomxApplicationState
{
    /**
     * Constructs a new discussion 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\Extensions\FamilySearch\Rs\Client\FamilySearchStateFactory $stateFactory
     */
    public function __construct(Client $client, Request $request, Response $response, $accessToken, FamilySearchStateFactory $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\Extensions\FamilySearch\Rs\Client\DiscussionState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new DiscussionState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

    /**
     * Gets the main data element represented by this state instance.
     *
     * @return \Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion
     */
    protected function getScope()
    {
        return $this->getDiscussion();
    }

    /**
     * Gets the first discussion from the current entity (FamilySearchPlatform::getDiscussions()).
     *
     * @return Discussion
     */
    public function getDiscussion()
    {
        if ($this->entity) {
            $discussions = $this->entity->getDiscussions();
            if (count($discussions) > 0) {
                return $discussions[0];
            }
        }

        return null;
    }

    /**
     * Creates a new discussion and only sets the discussion ID to the current discussion's ID.
     *
     * @return Discussion
     */
    protected function createEmptySelf()
    {
        $discussion = new Discussion();
        $discussion->setId($this->getLocalSelfId());
        return $discussion;
    }

    /**
     * Gets the current discussion ID.
     *
     * @return string|null
     */
    protected function getLocalSelfId()
    {
        $me = $this->getDiscussion();
        return $me == null ? null : $me->getId();
    }

    /**
     * Returns the entity from the REST API response.
     *
     * @return \Gedcomx\Extensions\FamilySearch\FamilySearchPlatform
     */
    protected function loadEntity()
    {
        $json = json_decode($this->response->getBody(), true);

        return new FamilySearchPlatform($json);
    }

    /**
     * Loads the comments for the current discussion.
     *
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    public function loadComments(StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::COMMENTS);
        if ($this->entity != null && $link != null && $link->getHref() != null) {
            $this->passOptionsTo('embed', array($link), func_get_args());
        }

        return $this;
    }

    /**
     * Creates a REST API request (with appropriate authentication headers).
     *
     * @param string $method
     * @param Link $link
     * @return Request
     */
    protected function createRequestForEmbeddedResource($method, Link $link)
    {
        return $this->createAuthenticatedGedcomxRequest($method, $link->getHref(), FamilySearchRequest::getMediaTypes());
    }

    /**
     * Updates the specified discussion.
     *
     * @param \Gedcomx\Extensions\FamilySearch\Platform\Discussions\Discussion $discussion
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption                 $option,...
     *
     * @return mixed
     */
    public function update(Discussion $discussion, StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('updateInternal', array($discussion, Rel::SELF), func_get_args());
    }

    /**
     * Adds a comment to the current discussion.
     *
     * @param String                                           $comment
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    public function addCommentString($comment, StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('addComments', array(array(new Comment($comment))), func_get_args());
    }

    /**
     * Adds a comment to the current discussion.
     *
     * @param Comment               $comment
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    public function addComment(Comment $comment, StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('addComments', array(array($comment)), func_get_args());
    }

    /**
     * Adds the specified comments to the current discussion.
     *
     * @param Comment[]             $comments
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    public function addComments(array $comments, StateTransitionOption $option = null)
    {
        $discussion = $this->createEmptySelf();
        $discussion->setComments($comments);
        return $this->passOptionsTo('updateInternal', array($discussion, Rel::COMMENTS), func_get_args());
    }

    /**
     * Updates the specified comment on the current discussion.
     *
     * @param Comment               $comment
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    public function updateComment(Comment $comment, StateTransitionOption $option = null)
    {
        return $this->passOptionsTo('updateComments', array(array($comment)), func_get_args());
    }

    /**
     * Updates the specified comments on the current discussion.
     *
     * @param Comment[]             $comments
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    public function updateComments(array $comments, StateTransitionOption $option = null)
    {
        $discussion = $this->createEmptySelf();
        $discussion->setComments($comments);
        return $this->passOptionsTo('updateInternal', array($discussion,Rel::COMMENTS), func_get_args());
    }

    /**
     * Updates the specified discussion.
     *
     * @param Discussion            $discussion
     * @param string                $rel
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     */
    protected function updateInternal(Discussion $discussion, $rel, StateTransitionOption $option = null)
    {
        $target = $this->getSelfUri();
        $link = $this->getLink($rel);
        if ($link != null && $link->getHref() != null) {
            $target = $link->getHref();
        }

        $fsp = new FamilySearchPlatform();
        $fsp->setDiscussions(array($discussion));
        $request = $this->createAuthenticatedRequest('POST', $target, FamilySearchRequest::getMediaTypes(), null, $fsp->toJson());
        return $this->stateFactory->createState(
            'DiscussionState',
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }

    /**
     * Deletes the specified comment from the current discussion.
     *
     * @param Comment               $comment
     * @param StateTransitionOption $option,...
     *
     * @return DiscussionState
     * @throws GedcomxApplicationException
     */
    public function deleteComment(Comment $comment, StateTransitionOption $option = null)
    {
        $link = $comment->getLink(Rel::COMMENT);
        $link = $link == null ? $comment->getLink(Rel::SELF) : $link;
        if ($link == null || $link->getHref() == null) {
            throw new GedcomxApplicationException("Comment cannot be deleted: missing $link.");
        }

        $request = $this->createAuthenticatedGedcomxRequest('DELETE', $link->getHref(), FamilySearchRequest::getMediaTypes());
        return $this->stateFactory->createState(
            'DiscussionState',
            $this->client,
            $request,
            $this->passOptionsTo('invoke', array($request), func_get_args()),
            $this->accessToken
        );
    }
}

Namespaces

Classes

Interfaces

Exceptions