File Extensions/FamilySearch/Feature.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 314 315 316 317 318 319 320 321

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

namespace Gedcomx\Extensions\FamilySearch;

/**
 * A description of a FamilySearch feature.
 */
class Feature
{

    /**
     * The name of the feature.
     *
     * @var string
     */
    private $name;

    /**
     * A description of the feature.
     *
     * @var string
     */
    private $description;

    /**
     * Whether the feature is enabled for the current request.
     *
     * @var boolean
     */
    private $enabled;

    /**
     * The date that this feature is scheduled to activate permanently.
     *
     * @var integer
     */
    private $activationDate;

    /**
     * Constructs a Feature from a (parsed) JSON hash
     *
     * @param mixed $o Either an array (JSON) or an XMLReader.
     */
    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 name of the feature.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * The name of the feature.
     *
     * @param string $name
     */
    public function setName($name)
    {
        $this->name = $name;
    }
    /**
     * A description of the feature.
     *
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * A description of the feature.
     *
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }
    /**
     * Whether the feature is enabled for the current request.
     *
     * @return boolean
     */
    public function getEnabled()
    {
        return $this->enabled;
    }

    /**
     * Whether the feature is enabled for the current request.
     *
     * @param boolean $enabled
     */
    public function setEnabled($enabled)
    {
        $this->enabled = $enabled;
    }
    /**
     * The date that this feature is scheduled to activate permanently.
     *
     * @return integer
     */
    public function getActivationDate()
    {
        return $this->activationDate;
    }

    /**
     * The date that this feature is scheduled to activate permanently.
     *
     * @param integer $activationDate
     */
    public function setActivationDate($activationDate)
    {
        $this->activationDate = $activationDate;
    }
    /**
     * Returns the associative array for this Feature
     *
     * @return array
     */
    public function toArray()
    {
        $a = array();
        if ($this->name) {
            $a["name"] = $this->name;
        }
        if ($this->description) {
            $a["description"] = $this->description;
        }
        if ($this->enabled) {
            $a["enabled"] = $this->enabled;
        }
        if ($this->activationDate) {
            $a["activationDate"] = $this->activationDate;
        }
        return $a;
    }

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

    /**
     * Initializes this Feature from an associative array
     *
     * @param array $o
     */
    public function initFromArray($o)
    {
        if (isset($o['name'])) {
            $this->name = $o["name"];
        }
        if (isset($o['description'])) {
            $this->description = $o["description"];
        }
        if (isset($o['enabled'])) {
            $this->enabled = $o["enabled"];
        }
        if (isset($o['activationDate'])) {
            $this->activationDate = $o["activationDate"];
        }
    }

    /**
     * Initializes this Feature from an XML reader.
     *
     * @param \XMLReader $xml The reader to use to initialize this object.
     */
    public function initFromReader($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 Feature from an XML reader.
     *
     * @param \XMLReader $xml The reader.
     * @return bool Whether a child element was set.
     */
    protected function setKnownChildElement($xml) {
        $happened = false;
        if (($xml->localName == 'name') && ($xml->namespaceURI == 'http://familysearch.org/v1/')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->name = $child;
            $happened = true;
        }
        else if (($xml->localName == 'description') && ($xml->namespaceURI == 'http://familysearch.org/v1/')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->description = $child;
            $happened = true;
        }
        else if (($xml->localName == 'enabled') && ($xml->namespaceURI == 'http://familysearch.org/v1/')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->enabled = $child;
            $happened = true;
        }
        else if (($xml->localName == 'activationDate') && ($xml->namespaceURI == 'http://familysearch.org/v1/')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->activationDate = $child;
            $happened = true;
        }
        return $happened;
    }

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

        return false;
    }

    /**
     * Writes the contents of this Feature to an XML writer. The startElement is expected to be already provided.
     *
     * @param \XMLWriter $writer The XML writer.
     */
    public function writeXmlContents($writer)
    {
        if ($this->name) {
            $writer->startElementNs('fs', 'name', null);
            $writer->text($this->name);
            $writer->endElement();
        }
        if ($this->description) {
            $writer->startElementNs('fs', 'description', null);
            $writer->text($this->description);
            $writer->endElement();
        }
        if ($this->enabled) {
            $writer->startElementNs('fs', 'enabled', null);
            $writer->text($this->enabled);
            $writer->endElement();
        }
        if ($this->activationDate) {
            $writer->startElementNs('fs', 'activationDate', null);
            $writer->text($this->activationDate);
            $writer->endElement();
        }
    }
}

Namespaces

Classes

Interfaces

Exceptions