File Extensions/FamilySearch/Platform/Tree/Merge.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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

<?php
/**
 * Generated by <a href="http://enunciate.codehaus.org">Enunciate</a>.
 */

namespace Gedcomx\Extensions\FamilySearch\Platform\Tree;

use Gedcomx\Common\ResourceReference;
use Gedcomx\Extensions\FamilySearch\Rt\FamilySearchPlatformModelVisitor;

/**
 * Class Merge
 *
 *  * @package Gedcomx\Extensions\FamilySearch\Platform\Tree
 *
 *             Manage Merge Object
 */
class Merge
{
    /**
     * List of resources to remove from the survivor person.
     
     * 
*@var ResourceReference[]
     */
    private $resourcesToDelete;

    /**
     * List of resources to copy from the duplicate person to survivor person.
     
     * 
*@var ResourceReference[]
     */
    private $resourcesToCopy;

    /**
     * Constructs a Merge from a (parsed) JSON hash
     *
     * @param mixed $o Either an array (JSON) or an XMLReader.
     *
     * @throws \Exception
     */
    public function __construct($o = null)
    {
        if (is_array($o)) {
            $this->initFromArray($o);
        }
        else if ($o instanceof \XMLReader) {
            $success = true;
            while ($success && $o->nodeType != \XMLReader::ELEMENT) {
                $success = $o->read();
            }
            if ($o->nodeType != \XMLReader::ELEMENT) {
                throw new \Exception("Unable to read XML: no start element found.");
            }

            $this->initFromReader($o);
        }
    }

    /**
     * List of resources to remove from the survivor person.
     
     * 
*@return ResourceReference[]
     */
    public function getResourcesToDelete()
    {
        return $this->resourcesToDelete;
    }

    /**
     * List of resources to remove from the survivor person.
     
     * 
*@param ResourceReference[] $resourcesToDelete
     */
    public function setResourcesToDelete($resourcesToDelete)
    {
        $this->resourcesToDelete = $resourcesToDelete;
    }

    /**
     * Add a resource to the list of resources to delete from the survivor.
     
     * 
*@param ResourceReference $resource
     */
    public function addResourceToDelete(ResourceReference $resource)
    {
        $this->resourcesToDelete[] = $resource;
    }

    /**
     * List of resources to copy from the duplicate person to survivor person.
     
     * 
*@return ResourceReference[]
     */
    public function getResourcesToCopy()
    {
        return $this->resourcesToCopy;
    }

    /**
     * List of resources to copy from the duplicate person to survivor person.
     
     * 
* @param ResourceReference[] $resourcesToCopy
     */
    public function setResourcesToCopy($resourcesToCopy)
    {
        $this->resourcesToCopy = $resourcesToCopy;
    }

    /**
     * Add a resource to the list of resources to copy to the survivor.
     
     *
     * @param ResourceReference $resource
     */
    public function addResourceToCopy(ResourceReference $resource)
    {
        $this->resourcesToCopy[] = $resource;
    }

    /**
     * Returns the associative array for this Merge
     *
     * @return array
     */
    public function toArray()
    {
        $a = array();
        if ($this->resourcesToDelete) {
            $ab = array();
            foreach ($this->resourcesToDelete as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['resourcesToDelete'] = $ab;
        }
        if ($this->resourcesToCopy) {
            $ab = array();
            foreach ($this->resourcesToCopy as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['resourcesToCopy'] = $ab;
        }

        return $a;
    }

    /**
     * Returns the JSON string for this Merge
     *
     * @return string
     */
    public function toJson()
    {
        return json_encode($this->toArray());
    }

    /**
     * Initializes this Merge from an associative array
     *
     * @param array $o
     */
    public function initFromArray(array $o)
    {
        $this->resourcesToDelete = array();
        if (isset($o['resourcesToDelete'])) {
            foreach ($o['resourcesToDelete'] as $i => $x) {
                $this->resourcesToDelete[$i] = new ResourceReference($x);
            }
        }
        $this->resourcesToCopy = array();
        if (isset($o['resourcesToCopy'])) {
            foreach ($o['resourcesToCopy'] as $i => $x) {
                $this->resourcesToCopy[$i] = new ResourceReference($x);
            }
        }
    }

    /**
     * Initializes this Merge from an XML reader.
     *
     * @param \XMLReader $xml The reader to use to initialize this object.
     */
    public function initFromReader(\XMLReader $xml)
    {
        $empty = $xml->isEmptyElement;

        if ($xml->hasAttributes) {
            $moreAttributes = $xml->moveToFirstAttribute();
            while ($moreAttributes) {
                if (!$this->setKnownAttribute($xml)) {
                    //skip unknown attributes...
                }
                $moreAttributes = $xml->moveToNextAttribute();
            }
        }

        if (!$empty) {
            $xml->read();
            while ($xml->nodeType != \XMLReader::END_ELEMENT) {
                if ($xml->nodeType != \XMLReader::ELEMENT) {
                    //no-op: skip any insignificant whitespace, comments, etc.
                }
                else if (!$this->setKnownChildElement($xml)) {
                    $n = $xml->localName;
                    $ns = $xml->namespaceURI;
                    //skip the unknown element
                    while ($xml->nodeType != \XMLReader::END_ELEMENT && $xml->localName != $n && $xml->namespaceURI != $ns) {
                        $xml->read();
                    }
                }
                $xml->read(); //advance the reader.
            }
        }
    }

    /**
     * Sets a known child element of Merge from an XML reader.
     *
     * @param \XMLReader $xml The reader.
     *
     * @return bool Whether a child element was set.
     */
    protected function setKnownChildElement(\XMLReader $xml)
    {
        $happened = false;
        if (($xml->localName == 'resourceToDelete') && ($xml->namespaceURI == 'http://familysearch.org/v1/')) {
            $child = new ResourceReference($xml);
            if (!isset($this->resourcesToDelete)) {
                $this->resourcesToDelete = array();
            }
            array_push($this->resourcesToDelete, $child);
            $happened = true;
        }
        else if (($xml->localName == 'resourceToCopy') && ($xml->namespaceURI == 'http://familysearch.org/v1/')) {
            $child = new ResourceReference($xml);
            if (!isset($this->resourcesToCopy)) {
                $this->resourcesToCopy = array();
            }
            array_push($this->resourcesToCopy, $child);
            $happened = true;
        }
        return $happened;
    }

    /**
     * Sets a known attribute of Merge from an XML reader.
     *
     * @param \XMLReader $xml The reader.
     *
     * @return bool Whether an attribute was set.
     */
    protected function setKnownAttribute(\XMLReader $xml)
    {
        return false;
    }

    /**
     * Writes this Merge to an XML writer.
     *
     * @param \XMLWriter $writer            The XML writer.
     * @param bool       $includeNamespaces Whether to write out the namespaces in the element.
     */
    public function toXml(\XMLWriter $writer, $includeNamespaces = true)
    {
        $writer->startElementNS('fs', 'merge', null);
        if ($includeNamespaces) {
            $writer->writeAttributeNs('xmlns', 'gx', null, 'http://gedcomx.org/v1/');
            $writer->writeAttributeNs('xmlns', 'fs', null, 'http://familysearch.org/v1/');
        }
        $this->writeXmlContents($writer);
        $writer->endElement();
    }

    /**
     * Writes the contents of this Merge to an XML writer. The startElement is expected to be already provided.
     *
     * @param \XMLWriter $writer The XML writer.
     */
    public function writeXmlContents(\XMLWriter $writer)
    {
        if ($this->resourcesToDelete) {
            foreach ($this->resourcesToDelete as $i => $x) {
                $writer->startElementNs('fs', 'resourceToDelete', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->resourcesToCopy) {
            foreach ($this->resourcesToCopy as $i => $x) {
                $writer->startElementNs('fs', 'resourceToCopy', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
    }

    /**
     * Accept a visitor.
     *
     * @param \Gedcomx\Extensions\FamilySearch\Rt\FamilySearchPlatformModelVisitor $visitor
     */
    public function accept(FamilySearchPlatformModelVisitor $visitor)
    {
        $visitor->visitMerge($this);
    }
}

Namespaces

Classes

Interfaces

Exceptions