File Source/Coverage.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

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

namespace Gedcomx\Source;

use Gedcomx\Conclusion\DateInfo;
use Gedcomx\Conclusion\PlaceReference;
use Gedcomx\Links\HypermediaEnabledData;

/**
 * A description of the coverage of a resource.
 */
class Coverage extends HypermediaEnabledData
{
    /**
     * The type of record being covered.
     *
     * @var string
     */
    private $recordType;

    /**
     * Spatial coverage.
     *
     * @var PlaceReference
     */
    private $spatial;

    /**
     * Temporal coverage.
     *
     * @var DateInfo
     */
    private $temporal;

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

    /**
     * The type of record being covered.
     *
     * @return string
     */
    public function getRecordType()
    {
        return $this->recordType;
    }

    /**
     * The type of record being covered.
     *
     * @param string $recordType
     */
    public function setRecordType($recordType)
    {
        $this->recordType = $recordType;
    }

    /**
     * Spatial coverage.
     *
     * @return \Gedcomx\Conclusion\PlaceReference
     */
    public function getSpatial()
    {
        return $this->spatial;
    }

    /**
     * Spatial coverage.
     *
     * @param \Gedcomx\Conclusion\PlaceReference $spatial
     */
    public function setSpatial(PlaceReference $spatial)
    {
        $this->spatial = $spatial;
    }

    /**
     * Temporal coverage.
     *
     * @return \Gedcomx\Conclusion\DateInfo
     */
    public function getTemporal()
    {
        return $this->temporal;
    }

    /**
     * Temporal coverage.
     *
     * @param \Gedcomx\Conclusion\DateInfo $temporal
     */
    public function setTemporal(DateInfo $temporal)
    {
        $this->temporal = $temporal;
    }

    /**
     * Returns the associative array for this Coverage
     *
     * @return array
     */
    public function toArray()
    {
        $a = parent::toArray();
        if ($this->recordType) {
            $a["recordType"] = $this->recordType;
        }
        if ($this->spatial) {
            $a["spatial"] = $this->spatial->toArray();
        }
        if ($this->temporal) {
            $a["temporal"] = $this->temporal->toArray();
        }

        return $a;
    }

    /**
     * Initializes this Coverage from an associative array
     *
     * @param array $o
     */
    public function initFromArray(array $o)
    {
        parent::initFromArray($o);
        if (isset($o['recordType'])) {
            $this->recordType = $o["recordType"];
        }
        if (isset($o['spatial'])) {
            $this->spatial = new PlaceReference($o["spatial"]);
        }
        if (isset($o['temporal'])) {
            $this->temporal = new DateInfo($o["temporal"]);
        }
    }

    /**
     * Sets a known child element of Coverage 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 == 'recordType') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
                $child = '';
                while ($xml->read() && $xml->hasValue) {
                    $child = $child . $xml->value;
                }
                $this->recordType = $child;
                $happened = true;
            } else {
                if (($xml->localName == 'spatial') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
                    $child = new PlaceReference($xml);
                    $this->spatial = $child;
                    $happened = true;
                } else {
                    if (($xml->localName == 'temporal') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
                        $child = new DateInfo($xml);
                        $this->temporal = $child;
                        $happened = true;
                    }
                }
            }
        }

        return $happened;
    }

    /**
     * Sets a known attribute of Coverage 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;
        }

        return false;
    }

    /**
     * Writes this Coverage 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('gx', 'coverage', null);
        if ($includeNamespaces) {
            $writer->writeAttributeNs('xmlns', 'gx', null, 'http://gedcomx.org/v1/');
        }
        $this->writeXmlContents($writer);
        $writer->endElement();
    }

    /**
     * Writes the contents of this Coverage to an XML writer. The startElement is expected to be already provided.
     *
     * @param \XMLWriter $writer The XML writer.
     */
    public function writeXmlContents(\XMLWriter $writer)
    {
        parent::writeXmlContents($writer);
        if ($this->recordType) {
            $writer->startElementNs('gx', 'recordType', null);
            $writer->text($this->recordType);
            $writer->endElement();
        }
        if ($this->spatial) {
            $writer->startElementNs('gx', 'spatial', null);
            $this->spatial->writeXmlContents($writer);
            $writer->endElement();
        }
        if ($this->temporal) {
            $writer->startElementNs('gx', 'temporal', null);
            $this->temporal->writeXmlContents($writer);
            $writer->endElement();
        }
    }
}

Namespaces

Classes

Interfaces

Exceptions