File Rs/Client/PersonChildrenState.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 283 284

<?php
/**
 * Copyright Intellectual Reserve, Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *   http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Gedcomx\Rs\Client;

use Gedcomx\Conclusion\Person;
use Gedcomx\Conclusion\Relationship;
use Gedcomx\Gedcomx;
use Gedcomx\Rs\Client\Exception\GedcomxApplicationException;
use Gedcomx\Rs\Client\PersonsState;
use Gedcomx\Rs\Client\Options\StateTransitionOption;
use Gedcomx\Rs\Client\Rel;
use Gedcomx\Rs\Client\StateFactory;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;

/**
 * The PersonChildrenState exposes management functions for person children.
 *
 * Class PersonChildrenState
 *
 * @package Gedcomx\Rs\Client
 */
class PersonChildrenState extends PersonsState
{
    /**
     * Constructs a new person children state using the specified client, request, respons, 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
     */
    public 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\PersonChildrenState
     */
    protected function reconstruct(Request $request, Response $response)
    {
        return new PersonChildrenState($this->client, $request, $response, $this->accessToken, $this->stateFactory);
    }

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

    /**
     * Gets the array of persons represented by the current state instance.
     *
     * @return null
     */
    public function getPersons()
    {
        return $this->entity == null ? null : $this->entity->getPersons();
    }

    /**
     * Return the relationships associated with this person.
     *
     * @return \Gedcomx\Conclusion\Relationship[]
     */
    public function getRelationships()
    {
        return $this->entity == null ? null : $this->entity->getRelationships();
    }

    /**
     * Finds the relationship to the specified child.
     * This method iterates over the current relationships, and each item is examined
     * to determine if the child ID in the relationship matches the child ID for the specified child. If one is found,
     * that relationship object containing that child ID is returned, and no other relationships are examined further.
     *
     * @param \Gedcomx\Conclusion\Person $child
     *
     * @return \Gedcomx\Conclusion\Relationship|null
     */
    public function findRelationshipTo(Person $child)
    {
        $relationships = $this->getRelationships();
        if ($relationships != null) {
            foreach ($relationships as $relationship) {
                $childReference = $relationship->getPerson2();
                if ($childReference != null) {
                    $reference = $childReference->getResource();
                    if ($reference == "#" . $child->getId()) {
                        return $relationship;
                    }
                }
            }
        }

        return null;
    }

    /**
     * Reads the current person represented by this state instance.
     *
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption|null $option,... zero or more StateTransitionObjects
     *
     * @return \Gedcomx\Rs\Client\PersonState
     */
    public function readPerson(StateTransitionOption $option = null)
    {
        $link = $this->getLink(Rel::PERSON);
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedGedcomxRequest('GET', $link->getHref());

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

    /**
     * Reads the child from the person specified.
     *
     * @param \Gedcomx\Conclusion\Person                            $person
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption|null $option,... zero or more StateTransitionObjects
     *
     * @return \Gedcomx\Rs\Client\PersonState
     */
    public function readChild(Person $person, StateTransitionOption $option = null)
    {
        $link = $person->getLink(Rel::PERSON);
        if ($link == null) {
            $link = $person->getLink(Rel::SELF);
        }
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedGedcomxRequest('GET', $link->getHref());

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

    /**
     * Reads the specified relationship.
     *
     * @param \Gedcomx\Conclusion\Relationship                      $relationship
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption|null $option,... zero or more StateTransitionObjects
     *
     * @return null
     */
    public function readRelationship(Relationship $relationship, StateTransitionOption $option = null)
    {
        $link = $relationship->getLink(Rel::RELATIONSHIP);
        if ($link == null) {
            $link = $relationship->getLink(Rel::SELF);
        }
        if ($link == null || $link->getHref() == null) {
            return null;
        }

        $request = $this->createAuthenticatedGedcomxRequest('GET', $link->getHref());

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

    /**
     * Removes the specified relationship.
     *
     * @param \Gedcomx\Conclusion\Relationship                      $relationship
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption|null $option,...
     *
     * @return \Gedcomx\Rs\Client\RelationshipState
     * @throws \Gedcomx\Rs\Client\Exception\GedcomxApplicationException
     */
    public function removeRelationship(Relationship $relationship, StateTransitionOption $option = null)
    {
        $link = $relationship->getLink(Rel::RELATIONSHIP);
        if ($link == null) {
            $link = $relationship->getLink(Rel::SELF);
        }
        if ($link == null || $link->getHref() == null) {
            throw new GedcomxApplicationException("Unable to remove relationship: missing link.");
        }

        $request = $this->createAuthenticatedGedcomxRequest('DELETE', $link->getHref());

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

    /**
     * Removes the relationship to the specified child.
     *
     * @param \Gedcomx\Conclusion\Person                            $child
     * @param \Gedcomx\Rs\Client\Options\StateTransitionOption|null $option,...
     *
     * @return mixed
     * @throws GedcomxApplicationException
     */
    public function removeRelationshipTo(Person $child, StateTransitionOption $option = null)
    {
        $relationship = $this->findRelationshipTo($child);
        if ($relationship == null) {
            throw new GedcomxApplicationException("Unable to remove relationship: not found.");
        }

        $link = $relationship->getLink(Rel::RELATIONSHIP);
        if ($link == null) {
            $link = $relationship->getLink(Rel::SELF);
        }
        if ($link == null || $link->getHref() == null) {
            throw new GedcomxApplicationException("Unable to remove relationship: missing link.");
        }

        $request = $this->createAuthenticatedGedcomxRequest('DELETE', $link->getHref());

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

Namespaces

Classes

Interfaces

Exceptions