File Atom/Feed.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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861

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

namespace Gedcomx\Atom;
use Gedcomx\Links\Link;
use Gedcomx\Records\Field;

/**
 * <p>The Atom data formats provide a format for web content and metadata syndication. The XML media type is defined by
 * <a href="http://tools.ietf.org/html/rfc4287#section-4">RFC 4287</a>. The JSON data format is specific to GEDCOM X
 * and is a translation to JSON from the XML.</p>
 */
class Feed extends ExtensibleElement
{

    /**
     * The author of the feed.
     *
     * @var Person[]
     */
    private $authors;

    /**
     * information about a category associated with the feed
     *
     * @var Person[]
     */
    private $contributors;

    /**
     * identifies the agent used to generate the feed
     *
     * @var Generator
     */
    private $generator;

    /**
     * identifies an image that provides iconic visual identification for the feed.
     *
     * @var string
     */
    private $icon;

    /**
     * a permanent, universally unique identifier for the feed.
     *
     * @var string
     */
    private $id;

    /**
     * The total number of results available, if this feed is supplying a subset of results, such as for a query.
     *
     * @var integer
     */
    private $results;

    /**
     * The index of the first entry in this page of data, if this feed is supplying a page of data.
     *
     * @var integer
     */
    private $index;

    /**
     * a reference from a feed to a Web resource.
     *
     * @var Link[]
     */
    private $links;

    /**
     * identifies an image that provides visual identification for the feed.
     *
     * @var string
     */
    private $logo;

    /**
     * information about rights held in and over the feed.
     *
     * @var string
     */
    private $rights;

    /**
     * a human-readable description or subtitle for the feed.
     *
     * @var string
     */
    private $subtitle;

    /**
     * a human-readable title for the feed
     *
     * @var string
     */
    private $title;

    /**
     * the most recent instant in time when the feed was modified in a way the publisher considers significant.
     *
     * @var integer
     */
    private $updated;

    /**
     * The entries in the feed.
     *
     * @var Entry[]
     */
    private $entries;

    /**
     * The list of facets for the feed, used for convenience in browsing and filtering.
     *
     * @var Field[]
     */
    private $facets;

    /**
     * Constructs a Feed 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 author of the feed.
     *
     * @return Person[]
     */
    public function getAuthors()
    {
        return $this->authors;
    }

    /**
     * The author of the feed.
     *
     * @param Person[] $authors
     */
    public function setAuthors($authors)
    {
        $this->authors = $authors;
    }
    /**
     * information about a category associated with the feed
     *
     * @return Person[]
     */
    public function getContributors()
    {
        return $this->contributors;
    }

    /**
     * information about a category associated with the feed
     *
     * @param Person[] $contributors
     */
    public function setContributors($contributors)
    {
        $this->contributors = $contributors;
    }
    /**
     * identifies the agent used to generate the feed
     *
     * @return Generator
     */
    public function getGenerator()
    {
        return $this->generator;
    }

    /**
     * identifies the agent used to generate the feed
     *
     * @param Generator $generator
     */
    public function setGenerator($generator)
    {
        $this->generator = $generator;
    }
    /**
     * identifies an image that provides iconic visual identification for the feed.
     *
     * @return string
     */
    public function getIcon()
    {
        return $this->icon;
    }

    /**
     * identifies an image that provides iconic visual identification for the feed.
     *
     * @param string $icon
     */
    public function setIcon($icon)
    {
        $this->icon = $icon;
    }
    /**
     * a permanent, universally unique identifier for the feed.
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * a permanent, universally unique identifier for the feed.
     *
     * @param string $id
     */
    public function setId($id)
    {
        $this->id = $id;
    }
    /**
     * The total number of results available, if this feed is supplying a subset of results, such as for a query.
     *
     * @return integer
     */
    public function getResults()
    {
        return $this->results;
    }

    /**
     * The total number of results available, if this feed is supplying a subset of results, such as for a query.
     *
     * @param integer $results
     */
    public function setResults($results)
    {
        $this->results = $results;
    }
    /**
     * The index of the first entry in this page of data, if this feed is supplying a page of data.
     *
     * @return integer
     */
    public function getIndex()
    {
        return $this->index;
    }

    /**
     * The index of the first entry in this page of data, if this feed is supplying a page of data.
     *
     * @param integer $index
     */
    public function setIndex($index)
    {
        $this->index = $index;
    }
    /**
     * a reference from a feed to a Web resource.
     *
     * @return Link[]
     */
    public function getLinks()
    {
        return $this->links;
    }

    /**
     * a reference from a feed to a Web resource.
     *
     * @param Link[] $links
     */
    public function setLinks($links)
    {
        $this->links = $links;
    }
    /**
     * identifies an image that provides visual identification for the feed.
     *
     * @return string
     */
    public function getLogo()
    {
        return $this->logo;
    }

    /**
     * identifies an image that provides visual identification for the feed.
     *
     * @param string $logo
     */
    public function setLogo($logo)
    {
        $this->logo = $logo;
    }
    /**
     * information about rights held in and over the feed.
     *
     * @return string
     */
    public function getRights()
    {
        return $this->rights;
    }

    /**
     * information about rights held in and over the feed.
     *
     * @param string $rights
     */
    public function setRights($rights)
    {
        $this->rights = $rights;
    }
    /**
     * a human-readable description or subtitle for the feed.
     *
     * @return string
     */
    public function getSubtitle()
    {
        return $this->subtitle;
    }

    /**
     * a human-readable description or subtitle for the feed.
     *
     * @param string $subtitle
     */
    public function setSubtitle($subtitle)
    {
        $this->subtitle = $subtitle;
    }
    /**
     * a human-readable title for the feed
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * a human-readable title for the feed
     *
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }
    /**
     * the most recent instant in time when the feed was modified in a way the publisher considers significant.
     *
     * @return integer
     */
    public function getUpdated()
    {
        return $this->updated;
    }

    /**
     * the most recent instant in time when the feed was modified in a way the publisher considers significant.
     *
     * @param integer $updated
     */
    public function setUpdated($updated)
    {
        $this->updated = $updated;
    }
    /**
     * The entries in the feed.
     *
     * @return Entry[]
     */
    public function getEntries()
    {
        return $this->entries;
    }

    /**
     * The entries in the feed.
     *
     * @param Entry[] $entries
     */
    public function setEntries($entries)
    {
        $this->entries = $entries;
    }
    /**
     * The list of facets for the feed, used for convenience in browsing and filtering.
     *
     * @return Field[]
     */
    public function getFacets()
    {
        return $this->facets;
    }

    /**
     * The list of facets for the feed, used for convenience in browsing and filtering.
     *
     * @param Field[] $facets
     */
    public function setFacets($facets)
    {
        $this->facets = $facets;
    }
    /**
     * Returns the associative array for this Feed
     *
     * @return array
     */
    public function toArray()
    {
        $a = parent::toArray();
        if ($this->authors) {
            $ab = array();
            foreach ($this->authors as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['authors'] = $ab;
        }
        if ($this->contributors) {
            $ab = array();
            foreach ($this->contributors as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['contributors'] = $ab;
        }
        if ($this->generator) {
            $a["generator"] = $this->generator->toArray();
        }
        if ($this->icon) {
            $a["icon"] = $this->icon;
        }
        if ($this->id) {
            $a["id"] = $this->id;
        }
        if ($this->results) {
            $a["results"] = $this->results;
        }
        if ($this->index) {
            $a["index"] = $this->index;
        }
        if ($this->links) {
            $ab = array();
            foreach ($this->links as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['links'] = $ab;
        }
        if ($this->logo) {
            $a["logo"] = $this->logo;
        }
        if ($this->rights) {
            $a["rights"] = $this->rights;
        }
        if ($this->subtitle) {
            $a["subtitle"] = $this->subtitle;
        }
        if ($this->title) {
            $a["title"] = $this->title;
        }
        if ($this->updated) {
            $a["updated"] = $this->updated;
        }
        if ($this->entries) {
            $ab = array();
            foreach ($this->entries as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['entries'] = $ab;
        }
        if ($this->facets) {
            $ab = array();
            foreach ($this->facets as $i => $x) {
                $ab[$i] = $x->toArray();
            }
            $a['facets'] = $ab;
        }
        return $a;
    }


    /**
     * Initializes this Feed from an associative array
     *
     * @param array $o
     */
    public function initFromArray($o)
    {
        $this->authors = array();
        if (isset($o['authors'])) {
            foreach ($o['authors'] as $i => $x) {
                $this->authors[$i] = new Person($x);
            }
            unset($o['authors']);
        }
        $this->contributors = array();
        if (isset($o['contributors'])) {
            foreach ($o['contributors'] as $i => $x) {
                $this->contributors[$i] = new Person($x);
            }
            unset($o['contributors']);
        }
        if (isset($o['generator'])) {
            $this->generator = new Generator($o["generator"]);
            unset($o['generator']);
        }
        if (isset($o['icon'])) {
            $this->icon = $o["icon"];
            unset($o['icon']);
        }
        if (isset($o['id'])) {
            $this->id = $o["id"];
            unset($o['id']);
        }
        if (isset($o['results'])) {
            $this->results = $o["results"];
            unset($o['results']);
        }
        if (isset($o['index'])) {
            $this->index = $o["index"];
            unset($o['index']);
        }
        $this->links = array();
        if (isset($o['links'])) {
            foreach ($o['links'] as $i => $x) {
                if( ! array_key_exists("rel", $x) ){
                    $x["rel"] = $i;
                }
                $this->links[$i] = new Link($x);
            }
            unset($o['links']);
        }
        if (isset($o['logo'])) {
            $this->logo = $o["logo"];
            unset($o['logo']);
        }
        if (isset($o['rights'])) {
            $this->rights = $o["rights"];
            unset($o['rights']);
        }
        if (isset($o['subtitle'])) {
            $this->subtitle = $o["subtitle"];
            unset($o['subtitle']);
        }
        if (isset($o['title'])) {
            $this->title = $o["title"];
            unset($o['title']);
        }
        if (isset($o['updated'])) {
            $this->updated = $o["updated"];
            unset($o['updated']);
        }
        $this->entries = array();
        if (isset($o['entries'])) {
            foreach ($o['entries'] as $i => $x) {
                $this->entries[$i] = new Entry($x);
            }
            unset($o['entries']);
        }
        $this->facets = array();
        if (isset($o['facets'])) {
            foreach ($o['facets'] as $i => $x) {
                $this->facets[$i] = new Field($x);
            }
            unset($o['facets']);
        }
        parent::initFromArray($o);
    }

    /**
     * Sets a known child element of Feed from an XML reader.
     *
     * @param \XMLReader $xml The reader.
     *
     * @return bool Whether a child element was set.
     */
    protected function setKnownChildElement($xml) {
        $happened = parent::setKnownChildElement($xml);
        if ($happened) {
          return true;
        }
        else if (($xml->localName == 'author') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = new Person($xml);
            if (!isset($this->authors)) {
                $this->authors = array();
            }
            array_push($this->authors, $child);
            $happened = true;
        }
        else if (($xml->localName == 'contributor') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = new Person($xml);
            if (!isset($this->contributors)) {
                $this->contributors = array();
            }
            array_push($this->contributors, $child);
            $happened = true;
        }
        else if (($xml->localName == 'generator') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = new Generator($xml);
            $this->generator = $child;
            $happened = true;
        }
        else if (($xml->localName == 'icon') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->icon = $child;
            $happened = true;
        }
        else if (($xml->localName == 'id') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->id = $child;
            $happened = true;
        }
        else if (($xml->localName == 'results') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->results = $child;
            $happened = true;
        }
        else if (($xml->localName == 'index') && ($xml->namespaceURI == 'http://gedcomx.org/v1/')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->index = $child;
            $happened = true;
        }
        else if (($xml->localName == 'link') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = new Link($xml);
            if (!isset($this->links)) {
                $this->links = array();
            }
            array_push($this->links, $child);
            $happened = true;
        }
        else if (($xml->localName == 'logo') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->logo = $child;
            $happened = true;
        }
        else if (($xml->localName == 'rights') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->rights = $child;
            $happened = true;
        }
        else if (($xml->localName == 'subtitle') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->subtitle = $child;
            $happened = true;
        }
        else if (($xml->localName == 'title') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->title = $child;
            $happened = true;
        }
        else if (($xml->localName == 'updated') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = '';
            while ($xml->read() && $xml->hasValue) {
                $child = $child . $xml->value;
            }
            $this->updated = $child;
            $happened = true;
        }
        else if (($xml->localName == 'entry') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = new Entry($xml);
            if (!isset($this->entries)) {
                $this->entries = array();
            }
            array_push($this->entries, $child);
            $happened = true;
        }
        else if (($xml->localName == 'facet') && ($xml->namespaceURI == 'http://www.w3.org/2005/Atom')) {
            $child = new Field($xml);
            if (!isset($this->facets)) {
                $this->facets = array();
            }
            array_push($this->facets, $child);
            $happened = true;
        }
        return $happened;
    }

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

        return false;
    }

    /**
     * Writes this Feed 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($writer, $includeNamespaces = true)
    {
        $writer->startElementNS('atom', 'feed', null);
        if ($includeNamespaces) {
            $writer->writeAttributeNs('xmlns', 'gx', null, 'http://gedcomx.org/v1/');
            $writer->writeAttributeNs('xmlns', 'atom', null, 'http://www.w3.org/2005/Atom');
        }
        $this->writeXmlContents($writer);
        $writer->endElement();
    }

    /**
     * Writes the contents of this Feed to an XML writer. The startElement is expected to be already provided.
     *
     * @param \XMLWriter $writer The XML writer.
     */
    public function writeXmlContents($writer)
    {
        parent::writeXmlContents($writer);
        if ($this->authors) {
            foreach ($this->authors as $i => $x) {
                $writer->startElementNs('atom', 'author', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->contributors) {
            foreach ($this->contributors as $i => $x) {
                $writer->startElementNs('atom', 'contributor', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->generator) {
            $writer->startElementNs('atom', 'generator', null);
            $this->generator->writeXmlContents($writer);
            $writer->endElement();
        }
        if ($this->icon) {
            $writer->startElementNs('atom', 'icon', null);
            $writer->text($this->icon);
            $writer->endElement();
        }
        if ($this->id) {
            $writer->startElementNs('atom', 'id', null);
            $writer->text($this->id);
            $writer->endElement();
        }
        if ($this->results) {
            $writer->startElementNs('gx', 'results', null);
            $writer->text($this->results);
            $writer->endElement();
        }
        if ($this->index) {
            $writer->startElementNs('gx', 'index', null);
            $writer->text($this->index);
            $writer->endElement();
        }
        if ($this->links) {
            foreach ($this->links as $i => $x) {
                $writer->startElementNs('atom', 'link', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->logo) {
            $writer->startElementNs('atom', 'logo', null);
            $writer->text($this->logo);
            $writer->endElement();
        }
        if ($this->rights) {
            $writer->startElementNs('atom', 'rights', null);
            $writer->text($this->rights);
            $writer->endElement();
        }
        if ($this->subtitle) {
            $writer->startElementNs('atom', 'subtitle', null);
            $writer->text($this->subtitle);
            $writer->endElement();
        }
        if ($this->title) {
            $writer->startElementNs('atom', 'title', null);
            $writer->text($this->title);
            $writer->endElement();
        }
        if ($this->updated) {
            $writer->startElementNs('atom', 'updated', null);
            $writer->text($this->updated);
            $writer->endElement();
        }
        if ($this->entries) {
            foreach ($this->entries as $i => $x) {
                $writer->startElementNs('atom', 'entry', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
        if ($this->facets) {
            foreach ($this->facets as $i => $x) {
                $writer->startElementNs('atom', 'facet', null);
                $x->writeXmlContents($writer);
                $writer->endElement();
            }
        }
    }
}

Namespaces

Classes

Interfaces

Exceptions