File Conclusion/Subject.php | gedcomx-php-client

  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 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

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

namespace Gedcomx\Conclusion;

use Gedcomx\Common\Attributable;
use Gedcomx\Common\EvidenceReference;
use Gedcomx\Common\ExtensibleData;
use Gedcomx\Source\SourceReference;

/**
 * The <tt>Subject</tt> data type defines the abstract concept of a genealogical <em>subject</em>. A <em>subject</em> is something with a unique and
 * intrinsic identity, e.g., a person, a location on the surface of the earth. We identify that <em>subject</em> in time and space using various supporting
 * <em>conclusions</em>, e.g. for a person: things like name, birth date, age, address, etc. We aggregate these supporting <em>conclusions</em> to form an
 * apparently-unique identity by which we can distinguish our <em>subject</em> from all other possible <em>subjects</em>.
 */
class Subject extends Conclusion implements Attributable
{

    /**
     * Whether this subject has been identified as &quot;extracted&quot;.
     *
     * @var boolean
     */
    private $extracted;

    /**
     * References to the evidence being referenced.
     *
     * @var EvidenceReference[]
     */
    private $evidence;

    /**
     * References to multimedia resources associated with this subject.
     *
     * @var SourceReference[]
     */
    private $media;

    /**
     * The list of identifiers for the subject.
     *
     * @var Identifier[]
     */
    private $identifiers;

    /**
     * Constructs a Subject 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);
        }
    }

    /**
     * Whether this subject has been identified as &quot;extracted&quot;.
     *
     * @return boolean
     */
    public function getExtracted()
    {
        return $this->extracted;
    }

    /**
     * Whether this subject has been identified as &quot;extracted&quot;.
     *
     * @param boolean $extracted
     */
    public function setExtracted($extracted)
    {
        $this->extracted = $extracted;
    }
    /**
     * References to the evidence being referenced.
     *
     * @return EvidenceReference[]
     */
    public function getEvidence()
    {
        return $this->evidence;
    }

    /**
     * References to the evidence being referenced.
     *
     * @param EvidenceReference[] $evidence
     */
    public function setEvidence($evidence)
    {
        $this->evidence = $evidence;
    }
    /**
     * References to multimedia resources associated with this subject.
     *
     * @return SourceReference[]
     */
    public function getMedia()
    {
        return $this->media;
    }

    /**
     * References to multimedia resources associated with this subject.
     *
     * @param SourceReference[] $media
     */
    public function setMedia($media)
    {
        $this->media = $media;
    }
    /**
     * The list of identifiers for the subject.
     *
     * @return Identifier[]
     */
    public function getIdentifiers()
    {
        return $this->identifiers;
    }

    /**
     * The list of identifiers for the subject.
     *
     * @param Identifier[] $identifiers
     */
    public function setIdentifiers($identifiers)
    {
        $this->identifiers = $identifiers;
    }
    /**
     * Returns the associative array for this Subject
     *
     * @return array
     */
    public function toArray()
    {
        $a = parent::toArray();
        if ($this->extracted) {
            $a["extracted"] = $this->extracted;
        }
        if ($this->evidence) {
            $ab = array();
            foreach ($this->evidence as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['evidence'] = $ab;
        }
        if ($this->media) {
            $ab = array();
            foreach ($this->media as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['media'] = $ab;
        }
        if ($this->identifiers) {
            $ab = array();
            foreach ($this->identifiers as $i => $x) {
                $ab[$x->getType()] = array($x->getValue());
            }
            $a['identifiers'] = $ab;
        }
        return $a;
    }


    /**
     * Initializes this Subject from an associative array
     *
     * @param array $o
     */
    public function initFromArray(array $o)
    {
        if (isset($o['extracted'])) {
            $this->extracted = $o["extracted"];
            unset($o['extracted']);
        }
        $this->evidence = array();
        if (isset($o['evidence'])) {
            foreach ($o['evidence'] as $i => $x) {
                $this->evidence[$i] = new EvidenceReference($x);
            }
            unset($o['evidence']);
        }
        $this->media = array();
        if (isset($o['media'])) {
            foreach ($o['media'] as $i => $x) {
                $this->media[$i] = new SourceReference($x);
            }
            unset($o['media']);
        }
        $this->identifiers = array();
        if (isset($o['identifiers'])) {
            $this->identifiers = array();
            foreach ($o['identifiers'] as $i => $x) {
                if (!is_array($x)) {
                    $x = array($x);
                }
                foreach($x as $idValue){
                    $identifier = new Identifier();
                    $identifier->setType($i);
                    $identifier->setValue($idValue);
                    array_push($this->identifiers, $identifier);
                }
            }
            unset($o['identifiers']);
        }
        parent::initFromArray($o);
    }

    /**
     * Sets a known child element of Subject from an XML reader.
     *
     * @param \XMLReader $xml The reader.
     *
     * @return bool Whether a child element was set.
     */
    protected function setKnownChildElement(\XMLReader $xml) {
        $happened = parent::setKnownChildElement($xml);
        if ($happened) {
          return true;
        }
        else if (($xml->localName == 'evidence') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
            $child = new EvidenceReference($xml);
            if (!isset($this->evidence)) {
                $this->evidence = array();
            }
            array_push($this->evidence, $child);
            $happened = true;
        }
        else if (($xml->localName == 'media') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
            $child = new SourceReference($xml);
            if (!isset($this->media)) {
                $this->media = array();
            }
            array_push($this->media, $child);
            $happened = true;
        }
        else if (($xml->localName == 'identifier') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
            $child = new Identifier($xml);
            if (!isset($this->identifiers)) {
                $this->identifiers = array();
            }
            array_push($this->identifiers, $child);
            $happened = true;
        }
        return $happened;
    }

    /**
     * Sets a known attribute of Subject from an XML reader.
     *
     * @param \XMLReader $xml The reader.
     *
     * @return bool Whether an attribute was set.
     */
    protected function setKnownAttribute(\XMLReader $xml) {
        if (parent::setKnownAttribute($xml)) {
            return true;
        }
        else if (($xml->localName == 'extracted') && (empty($xml->namespaceURI))) {
            $this->extracted = $xml->value;
            return true;
        }

        return false;
    }

    /**
     * Writes the contents of this Subject 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->extracted) {
            $writer->writeAttribute('extracted', $this->extracted);
        }
        parent::writeXmlContents($writer);
        if ($this->evidence) {
            foreach ($this->evidence as $i => $x) {
                $writer->startElementNs('gx', 'evidence', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->media) {
            foreach ($this->media as $i => $x) {
                $writer->startElementNs('gx', 'media', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->identifiers) {
            foreach ($this->identifiers as $i => $x) {
                $writer->startElementNs('gx', 'identifier', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
    }

}

Namespaces

Classes

Interfaces

Exceptions