├── .github
    └── workflows
    │   └── ci.yml
├── .gitignore
├── .php_cs.dist
├── CHANGELOG.md
├── LICENSE
├── README.md
├── bin
    └── EMPTY
├── composer.json
├── examples
    ├── reading-test1.php
    └── reading-test2.php
├── lib
    ├── Element
    │   ├── Category.php
    │   ├── Entry.php
    │   ├── Feed.php
    │   ├── Link.php
    │   ├── Person.php
    │   └── Source.php
    ├── Service.php
    └── Version.php
├── phpstan.neon
└── tests
    ├── Xml
        └── Atom
        │   └── ParseAtomTest.php
    └── phpunit.xml


/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | name: continuous-integration
 2 | on:
 3 |   push:
 4 |     branches:
 5 |       - master
 6 |       - release/*
 7 |   pull_request:
 8 | jobs:
 9 |   unit-testing:
10 |     name: PHPUnit (PHP ${{ matrix.php-versions }})
11 |     runs-on: ubuntu-latest
12 |     strategy:
13 |       fail-fast: false
14 |       matrix:
15 |         php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1']
16 |         coverage: ['pcov']
17 |         code-analysis: ['no']
18 |         include:
19 |           - php-versions: '7.1'
20 |             coverage: 'none'
21 |             code-analysis: 'yes'
22 |     steps:
23 |       - name: Checkout
24 |         uses: actions/checkout@v2
25 | 
26 |       - name: Setup PHP, with composer and extensions
27 |         uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
28 |         with:
29 |           php-version: ${{ matrix.php-versions }}
30 |           extensions: mbstring, dom, fileinfo, mysql, redis, opcache
31 |           coverage: ${{ matrix.coverage }}
32 |           tools: composer
33 | 
34 |       - name: Get composer cache directory
35 |         id: composer-cache
36 |         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
37 | 
38 |       - name: Cache composer dependencies
39 |         uses: actions/cache@v2
40 |         with:
41 |           path: ${{ steps.composer-cache.outputs.dir }}
42 |           # Use composer.json for key, if composer.lock is not committed.
43 |           # key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
44 |           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
45 |           restore-keys: ${{ runner.os }}-composer-
46 | 
47 |       - name: Install composer dependencies
48 |         run: composer install --no-progress --prefer-dist --optimize-autoloader
49 | 
50 |       - name: Code Analysis (PHP CS-Fixer)
51 |         if: matrix.code-analysis == 'yes'
52 |         run: php vendor/bin/php-cs-fixer fix --dry-run --diff
53 | 
54 |       - name: Code Analysis (PHPStan)
55 |         if: matrix.code-analysis == 'yes'
56 |         run: composer phpstan
57 | 
58 |       - name: Test with phpunit
59 |         run: vendor/bin/phpunit --configuration tests/phpunit.xml --coverage-clover clover.xml
60 | 
61 |       - name: Code Coverage
62 |         uses: codecov/codecov-action@v2
63 |         if: matrix.coverage != 'none'
64 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Composer
2 | vendor/
3 | composer.lock
4 | 
5 | # Tests
6 | tests/cov/
7 | tests/.phpunit.result.cache
8 | .php_cs.cache
9 | 


--------------------------------------------------------------------------------
/.php_cs.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $config = PhpCsFixer\Config::create();
 4 | $config->getFinder()
 5 |     ->exclude('vendor')
 6 |     ->in(__DIR__);
 7 | $config->setRules([
 8 |     '@PSR1' => true,
 9 |     '@Symfony' => true
10 | ]);
11 | 
12 | return $config;
13 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | ChangeLog
 2 | =========
 3 | 
 4 | 0.3.1 (2020-10-03)
 5 | ------------------
 6 | 
 7 | * #15: Add support for PHP 8.0 (@phil-davis)
 8 | 
 9 | 0.3.0 (2020-10-03)
10 | ------------------
11 | 
12 | * Add support for PHP 7.4 (@phil-davis)
13 | 
14 | 0.2.0 (2017-01-03)
15 | ------------------
16 | 
17 | * Now a PHP 7 package!
18 | * Uses sabre/xml 2.0.
19 | * Strict types everywhere.
20 | 
21 | 
22 | 0.1.0 (2016-02-14)
23 | ------------------
24 | 
25 | * Depending on sabre/xml 1.4.0.
26 | * #3: Fixed a number of bugs during serialization.
27 | * Don't serialize empty elements anymore.
28 | * Added unittests using example documents from the rfc.
29 | * Better order of properties in feed/entry, so that the more important
30 |   elements go on top.
31 | 
32 | 
33 | 0.0.2 (2015-12-30)
34 | ------------------
35 | 
36 | * Depending on sabre/xml 1.3.0.
37 | 
38 | 
39 | 0.0.1 (2015-12-23)
40 | ------------------
41 | 
42 | * First version!
43 | * Parses Atom feeds
44 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (C) 2015-2017 fruux GmbH (https://fruux.com/)
 2 | 
 3 | All rights reserved.
 4 | 
 5 | Redistribution and use in source and binary forms, with or without modification,
 6 | are permitted provided that the following conditions are met:
 7 | 
 8 |     * Redistributions of source code must retain the above copyright notice,
 9 |       this list of conditions and the following disclaimer.
10 |     * Redistributions in binary form must reproduce the above copyright notice,
11 |       this list of conditions and the following disclaimer in the documentation
12 |       and/or other materials provided with the distribution.
13 |     * Neither the name Sabre nor the names of its contributors
14 |       may be used to endorse or promote products derived from this software
15 |       without specific prior written permission.
16 | 
17 |     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 |     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 |     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 |     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 |     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 |     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 |     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 |     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 |     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 |     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 |     POSSIBILITY OF SUCH DAMAGE.
28 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | sabre/xml-atom
 2 | ===============
 3 | 
 4 | This package contains a reader and writer for the [Atom XML format][5].
 5 | It also serves as a sample implementation of the [sabre/xml][6] package.
 6 | 
 7 | 
 8 | Installation
 9 | ------------
10 | 
11 | Make sure you have [composer][1] installed, and then run:
12 | 
13 |     composer require sabre/xml-atom
14 | 
15 | 
16 | Build status
17 | ------------
18 | 
19 | | branch | status |
20 | | ------ | ------ |
21 | | master | [![Build Status](https://travis-ci.org/sabre-io/xml-atom.png?branch=master)](https://travis-ci.org/sabre-io/xml-atom) |
22 | 
23 | 
24 | Questions?
25 | ----------
26 | 
27 | Head over to the [sabre/dav mailinglist][2], or you can also just open a ticket
28 | on [GitHub][3].
29 | 
30 | 
31 | Made at fruux
32 | -------------
33 | 
34 | This library is being developed by [fruux][4]. Drop us a line for commercial
35 | services or enterprise support.
36 | 
37 | [1]: http://getcomposer.org/
38 | [2]: http://groups.google.com/group/sabredav-discuss
39 | [3]: https://github.com/fruux/sabre-skel/issues/
40 | [4]: https://fruux.com/
41 | [5]: https://tools.ietf.org/html/rfc4287
42 | [6]: https://github.com/fruux/sabre-xml/ 
43 | 


--------------------------------------------------------------------------------
/bin/EMPTY:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sabre-io/xml-atom/0f6223b5e3191603f45c6a3d9529355c557e69e3/bin/EMPTY


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "sabre/xml-atom",
 3 |     "description": "A reader and writer for the Atom format",
 4 |     "keywords": [
 5 |         "sabre",
 6 |         "xml",
 7 |         "atom",
 8 |         "rfc4287"
 9 |     ],
10 |     "homepage": "http://sabre.io/dav/",
11 |     "license": "BSD-3-Clause",
12 |     "require": {
13 |         "php"       : "^7.1 || ^8.0",
14 |         "sabre/xml" : "^2.0"
15 |     },
16 |     "authors": [
17 |         {
18 |             "name": "Evert Pot",
19 |             "email": "me@evertpot.com",
20 |             "homepage": "http://evertpot.com/",
21 |             "role": "Developer"
22 |         }
23 |     ],
24 |     "support": {
25 |         "forum": "https://groups.google.com/group/sabredav-discuss",
26 |         "source": "https://github.com/fruux/sabre-skel"
27 |     },
28 |     "autoload": {
29 |         "psr-4" : {
30 |             "Sabre\\Xml\\Atom\\" : "lib/"
31 |         }
32 |     },
33 |     "autoload-dev" : {
34 |         "psr-4" : {
35 |             "Sabre\\Xml\\Atom\\" : "tests/Xml/Atom"
36 |         }
37 |     },
38 |     "require-dev": {
39 |         "friendsofphp/php-cs-fixer": "~2.17.1",
40 |         "phpstan/phpstan": "^0.12",
41 |         "phpunit/phpunit" : "^7.5 || ^8.5 || ^9.0"
42 |     },
43 |     "scripts": {
44 |         "phpstan": [
45 |             "phpstan analyse lib tests"
46 |         ],
47 |         "cs-fixer": [
48 |             "php-cs-fixer fix"
49 |         ],
50 |         "phpunit": [
51 |             "phpunit --configuration tests/phpunit.xml"
52 |         ],
53 |         "test": [
54 |             "composer phpstan",
55 |             "composer cs-fixer",
56 |             "composer phpunit"
57 |         ]
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/examples/reading-test1.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | require __DIR__.'/../vendor/autoload.php';
 6 | 
 7 | $input = <<<XML
 8 | <?xml version="1.0" encoding="utf-8"?>
 9 | <feed xmlns="http://www.w3.org/2005/Atom">
10 |  <title type="text">dive into mark</title>
11 |  <subtitle type="html">
12 |    A &lt;em&gt;lot&lt;/em&gt; of effort
13 |    went into making this effortless
14 |  </subtitle>
15 |  <updated>2005-07-31T12:29:29Z</updated>
16 |  <id>tag:example.org,2003:3</id>
17 |  <link rel="alternate" type="text/html"
18 |   hreflang="en" href="http://example.org/"/>
19 |  <link rel="self" type="application/atom+xml"
20 |   href="http://example.org/feed.atom"/>
21 |  <rights>Copyright (c) 2003, Mark Pilgrim</rights>
22 |  <generator uri="http://www.example.com/" version="1.0">
23 |    Example Toolkit
24 |  </generator>
25 |  <entry>
26 |    <title>Atom draft-07 snapshot</title>
27 |    <link rel="alternate" type="text/html"
28 |     href="http://example.org/2005/04/02/atom"/>
29 |    <link rel="enclosure" type="audio/mpeg" length="1337"
30 |     href="http://example.org/audio/ph34r_my_podcast.mp3"/>
31 |    <id>tag:example.org,2003:3.2397</id>
32 |    <updated>2005-07-31T12:29:29Z</updated>
33 |    <published>2003-12-13T08:29:29-04:00</published>
34 |    <author>
35 |      <name>Mark Pilgrim</name>
36 |      <uri>http://example.org/</uri>
37 |      <email>f8dy@example.com</email>
38 |    </author>
39 |    <contributor>
40 |      <name>Sam Ruby</name>
41 |    </contributor>
42 |    <contributor>
43 |      <name>Joe Gregorio</name>
44 |    </contributor>
45 |    <content type="xhtml" xml:lang="en"
46 |     xml:base="http://diveintomark.org/">
47 |      <div xmlns="http://www.w3.org/1999/xhtml">
48 |        <p><i>[Update: The Atom draft is finished.]</i></p>
49 |      </div>
50 |    </content>
51 |  </entry>
52 | </feed>
53 | XML;
54 | 
55 | $service = new Sabre\Xml\Atom\Service();
56 | print_r($service->parse($input));
57 | 


--------------------------------------------------------------------------------
/examples/reading-test2.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | require __DIR__.'/../vendor/autoload.php';
 6 | 
 7 | $input = file_get_contents('http://evertpot.com/atom.xml');
 8 | 
 9 | $service = new Sabre\Xml\Atom\Service();
10 | print_r($service->parse($input));
11 | 


--------------------------------------------------------------------------------
/lib/Element/Category.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Sabre\Xml\Atom\Element;
 6 | 
 7 | /**
 8 |  * The category associated with the feed or element.
 9 |  *
10 |  * @see https://tools.ietf.org/html/rfc4287#section-4.2.2
11 |  *
12 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
13 |  * @author Evert Pot (http://evertpot.com/)
14 |  * @license http://sabre.io/license/
15 |  */
16 | class Category
17 | {
18 |     /**
19 |      * A term associated with the category. Similar to a tag.
20 |      *
21 |      * @var string
22 |      */
23 |     public $term;
24 | 
25 |     /**
26 |      * Categorization scheme, as an IRI.
27 |      *
28 |      * @var string
29 |      */
30 |     public $scheme;
31 | 
32 |     /**
33 |      * A human-readable label for the category.
34 |      *
35 |      * @var string
36 |      */
37 |     public $label;
38 | }
39 | 


--------------------------------------------------------------------------------
/lib/Element/Entry.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Sabre\Xml\Atom\Element;
  6 | 
  7 | /**
  8 |  * The entry is an individual item in a feed, such as a single blog article.
  9 |  *
 10 |  * @see https://tools.ietf.org/html/rfc4287#section-4.1.2
 11 |  *
 12 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
 13 |  * @author Evert Pot (http://evertpot.com/)
 14 |  * @license http://sabre.io/license/
 15 |  */
 16 | class Entry
 17 | {
 18 |     /**
 19 |      * The title for the entry.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     public $title;
 24 | 
 25 |     /**
 26 |      * Links associated with the feed.
 27 |      *
 28 |      * @var Link
 29 |      */
 30 |     public $link = [];
 31 | 
 32 |     /**
 33 |      * A unique identifier for the feed.
 34 |      *
 35 |      * This should never change, and should be a URI.
 36 |      *
 37 |      * @var string
 38 |      */
 39 |     public $id;
 40 | 
 41 |     /**
 42 |      * The last time the entry was updated.
 43 |      *
 44 |      * @var string
 45 |      */
 46 |     public $updated;
 47 | 
 48 |     /**
 49 |      * When the entry was first published.
 50 |      *
 51 |      * @var string
 52 |      */
 53 |     public $published;
 54 | 
 55 |     /**
 56 |      * Contains a summarized version of the entry.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     public $summary;
 61 | 
 62 |     /**
 63 |      * Authors for the entry.
 64 |      *
 65 |      * @var Person[]
 66 |      */
 67 |     public $author = [];
 68 | 
 69 |     /**
 70 |      * List of categories for the entry.
 71 |      *
 72 |      * @var Category[]
 73 |      */
 74 |     public $category = [];
 75 | 
 76 |     /**
 77 |      * Anyone who contributed to the entry.
 78 |      *
 79 |      * @var Person[]
 80 |      */
 81 |     public $contributor = [];
 82 | 
 83 |     /**
 84 |      * Content of the entry.
 85 |      *
 86 |      * @var string
 87 |      */
 88 |     public $content;
 89 | 
 90 |     /**
 91 |      * Copyright and such, as a string.
 92 |      *
 93 |      * @var string
 94 |      */
 95 |     public $rights;
 96 | 
 97 |     /**
 98 |      * If the entry was copied from another feed, the feed information should
 99 |      * be contained in the source.
100 |      *
101 |      * @var Source
102 |      */
103 |     public $source;
104 | }
105 | 


--------------------------------------------------------------------------------
/lib/Element/Feed.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Sabre\Xml\Atom\Element;
  6 | 
  7 | /**
  8 |  * The feed is the top-level element for all atom feeds.
  9 |  *
 10 |  * @see https://tools.ietf.org/html/rfc4287#section-4.1.1
 11 |  *
 12 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
 13 |  * @author Evert Pot (http://evertpot.com/)
 14 |  * @license http://sabre.io/license/
 15 |  */
 16 | class Feed
 17 | {
 18 |     /**
 19 |      * The main title for the feed.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     public $title;
 24 | 
 25 |     /**
 26 |      * Secondary title for the feed.
 27 |      *
 28 |      * @var string
 29 |      */
 30 |     public $subtitle;
 31 | 
 32 |     /**
 33 |      * Links associated with the feed.
 34 |      *
 35 |      * @var Link
 36 |      */
 37 |     public $link = [];
 38 | 
 39 |     /**
 40 |      * The last time the feed was updated.
 41 |      *
 42 |      * @var string
 43 |      */
 44 |     public $updated;
 45 | 
 46 |     /**
 47 |      * The date the feed was last published.
 48 |      *
 49 |      * @var string
 50 |      */
 51 |     public $published;
 52 | 
 53 |     /**
 54 |      * A unique identifier for the feed.
 55 |      *
 56 |      * This should never change, and should be a URI.
 57 |      *
 58 |      * @var string
 59 |      */
 60 |     public $id;
 61 | 
 62 |     /**
 63 |      * Copyright and such, as a string.
 64 |      *
 65 |      * @var string
 66 |      */
 67 |     public $rights;
 68 | 
 69 |     /**
 70 |      * The software that generated the feed.
 71 |      *
 72 |      * @var string
 73 |      */
 74 |     public $generator;
 75 | 
 76 |     /**
 77 |      * Authors for the feed.
 78 |      *
 79 |      * @var Person[]
 80 |      */
 81 |     public $author = [];
 82 | 
 83 |     /**
 84 |      * List of categories for the feed.
 85 |      *
 86 |      * @var Category[]
 87 |      */
 88 |     public $category = [];
 89 | 
 90 |     /**
 91 |      * Anyone who contributed to the feed.
 92 |      *
 93 |      * @var Person[]
 94 |      */
 95 |     public $contributer = [];
 96 | 
 97 |     /**
 98 |      * Url to an icon belonging to the feed.
 99 |      *
100 |      * @var string
101 |      */
102 |     public $icon;
103 | 
104 |     /**
105 |      * Uri to a logo for the feed.
106 |      *
107 |      * @var string
108 |      */
109 |     public $logo;
110 | 
111 |     /**
112 |      * The list of feed entries.
113 |      *
114 |      * @var Entry[]
115 |      */
116 |     public $entry = [];
117 | }
118 | 


--------------------------------------------------------------------------------
/lib/Element/Link.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Sabre\Xml\Atom\Element;
 6 | 
 7 | /**
 8 |  * The atom:link element links a feed or an entry to another resource.
 9 |  *
10 |  * @see https://tools.ietf.org/html/rfc4287#section-4.2.7
11 |  *
12 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
13 |  * @author Evert Pot (http://evertpot.com/)
14 |  * @license http://sabre.io/license/
15 |  */
16 | class Link
17 | {
18 |     /**
19 |      * Target of the link.
20 |      *
21 |      * @var string
22 |      */
23 |     public $href;
24 | 
25 |     /**
26 |      * Language of the target resource.
27 |      *
28 |      * @var string
29 |      */
30 |     public $hreflang;
31 | 
32 |     /**
33 |      * Relationship type (rel attribute).
34 |      *
35 |      * @var string
36 |      */
37 |     public $rel;
38 | 
39 |     /**
40 |      * Media type.
41 |      *
42 |      * @var string
43 |      */
44 |     public $type;
45 | 
46 |     /**
47 |      * Title of the link.
48 |      *
49 |      * @var string
50 |      */
51 |     public $title;
52 | 
53 |     /**
54 |      * Filesize of the target resource, in bytes.
55 |      *
56 |      * @var int
57 |      */
58 |     public $length;
59 | }
60 | 


--------------------------------------------------------------------------------
/lib/Element/Person.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Sabre\Xml\Atom\Element;
 6 | 
 7 | /**
 8 |  * A Person construct is an element that describes a person, corporation, or
 9 |  * similar entity.
10 |  *
11 |  * This is used by the atom:author and atom:contributer elements.
12 |  *
13 |  * @see https://tools.ietf.org/html/rfc4287#section-3.2
14 |  *
15 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
16 |  * @author Evert Pot (http://evertpot.com/)
17 |  * @license http://sabre.io/license/
18 |  */
19 | class Person
20 | {
21 |     /**
22 |      * Person's full name.
23 |      *
24 |      * @var string
25 |      */
26 |     public $name;
27 | 
28 |     /**
29 |      * URI for the person, such as a personal website.
30 |      *
31 |      * @var string
32 |      */
33 |     public $uri;
34 | 
35 |     /**
36 |      * An email address identifying the person.
37 |      *
38 |      * @var string
39 |      */
40 |     public $email;
41 | }
42 | 


--------------------------------------------------------------------------------
/lib/Element/Source.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Sabre\Xml\Atom\Element;
  6 | 
  7 | /**
  8 |  * This object represents the atom:source element.
  9 |  *
 10 |  * When an entry from a feed is aggregated from one feed to another, the
 11 |  * aggregated entry may contain a 'source' element containing all the
 12 |  * meta-data the original feed had.
 13 |  *
 14 |  * This object contains all the properties Feed has, except the entries.
 15 |  *
 16 |  * @see https://tools.ietf.org/html/rfc4287#section-4.2.11
 17 |  *
 18 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
 19 |  * @author Evert Pot (http://evertpot.com/)
 20 |  * @license http://sabre.io/license/
 21 |  */
 22 | class Source
 23 | {
 24 |     /**
 25 |      * Authors for the feed.
 26 |      *
 27 |      * @var Person[]
 28 |      */
 29 |     public $author = [];
 30 | 
 31 |     /**
 32 |      * List of categories for the feed.
 33 |      *
 34 |      * @var Category[]
 35 |      */
 36 |     public $category = [];
 37 | 
 38 |     /**
 39 |      * Anyone who contributed to the feed.
 40 |      *
 41 |      * @var Person[]
 42 |      */
 43 |     public $contributer = [];
 44 | 
 45 |     /**
 46 |      * The software that generated the feed.
 47 |      *
 48 |      * @var string
 49 |      */
 50 |     public $generator;
 51 | 
 52 |     /**
 53 |      * Url to an icon belonging to the feed.
 54 |      *
 55 |      * @var string
 56 |      */
 57 |     public $icon;
 58 | 
 59 |     /**
 60 |      * A unique identifier for the feed.
 61 |      *
 62 |      * This should never change, and should be a URI.
 63 |      *
 64 |      * @var string
 65 |      */
 66 |     public $id;
 67 | 
 68 |     /**
 69 |      * Links associated with the feed.
 70 |      *
 71 |      * @var Link
 72 |      */
 73 |     public $link = [];
 74 | 
 75 |     /**
 76 |      * Uri to a logo for the feed.
 77 |      *
 78 |      * @var string
 79 |      */
 80 |     public $logo;
 81 | 
 82 |     /**
 83 |      * Copyright and such, as a string.
 84 |      *
 85 |      * @var string
 86 |      */
 87 |     public $rights;
 88 | 
 89 |     /**
 90 |      * Secondary title for the feed.
 91 |      *
 92 |      * @var string
 93 |      */
 94 |     public $subtitle;
 95 | 
 96 |     /**
 97 |      * The main title for the feed.
 98 |      *
 99 |      * @var string
100 |      */
101 |     public $title;
102 | 
103 |     /**
104 |      * The last time the feed was updated.
105 |      *
106 |      * @var string
107 |      */
108 |     public $updated;
109 | }
110 | 


--------------------------------------------------------------------------------
/lib/Service.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Sabre\Xml\Atom;
 6 | 
 7 | /**
 8 |  * The Atom Service object gives you quick access to the writer and reader.
 9 |  *
10 |  * See \Sabre\Xml\Service for all the utility methods.
11 |  *
12 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
13 |  * @author Evert Pot (http://evertpot.com/)
14 |  * @license http://sabre.io/license/
15 |  */
16 | class Service extends \Sabre\Xml\Service
17 | {
18 |     const ATOM_NS = 'http://www.w3.org/2005/Atom';
19 |     const ATOM_DEFAULT_PREFIX = 'atom';
20 | 
21 |     /**
22 |      * Constructor.
23 |      */
24 |     public function __construct()
25 |     {
26 |         $this->namespaceMap[self::ATOM_NS] = self::ATOM_DEFAULT_PREFIX;
27 | 
28 |         $atom = '{'.self::ATOM_NS.'}';
29 | 
30 |         // The following elements are all simple xml elements, and we can use
31 |         // the VO system for mapping from PHP object to XML element.
32 |         $this->mapValueObject($atom.'feed', Element\Feed::class);
33 |         $this->mapValueObject($atom.'entry', Element\Entry::class);
34 |         $this->mapValueObject($atom.'source', Element\Source::class);
35 |         $this->mapValueObject($atom.'author', Element\Person::class);
36 |         $this->mapValueObject($atom.'contributer', Element\Person::class);
37 | 
38 |         // The following elements need custom (de-)serializers
39 | 
40 |         // This serializer takes an object and encodes all its properties as
41 |         // XML attributes.
42 |         $attributeWriter = function ($writer, $object) {
43 |             $attributes = get_object_vars($object);
44 | 
45 |             // remove properties with a null value from the list.
46 |             $attributes = array_filter(
47 |                 $attributes,
48 |                 function ($item) {
49 |                     return null !== $item;
50 |                 }
51 |             );
52 |             $writer->writeAttributes(
53 |                 $attributes
54 |             );
55 |         };
56 | 
57 |         // This deserializer takes all attributes from an xml element and
58 |         // turns the into properties of a class.
59 |         $attributeReader = function ($reader, $class) {
60 |             $attributes = $reader->parseAttributes();
61 |             $object = new $class();
62 |             foreach ($attributes as $key => $value) {
63 |                 if (property_exists($object, $key)) {
64 |                     $object->{$key} = $value;
65 |                 }
66 |             }
67 | 
68 |             // Always advance the reader
69 |             $reader->next();
70 | 
71 |             return $object;
72 |         };
73 | 
74 |         // atom:category
75 |         $this->classMap[Element\Category::class] = $attributeWriter;
76 |         $this->elementMap[$atom.'category'] = function ($reader) use ($attributeReader) {
77 |             return $attributeReader($reader, Element\Category::class);
78 |         };
79 |         // atom:link
80 |         $this->classMap[Element\Link::class] = $attributeWriter;
81 |         $this->elementMap[$atom.'link'] = function ($reader) use ($attributeReader) {
82 |             return $attributeReader($reader, Element\Link::class);
83 |         };
84 |     }
85 | }
86 | 


--------------------------------------------------------------------------------
/lib/Version.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | namespace Sabre\Xml\Atom;
 6 | 
 7 | /**
 8 |  * This class contains the version number for this package.
 9 |  *
10 |  * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
11 |  * @author Evert Pot (http://evertpot.com/)
12 |  * @license http://sabre.io/license/
13 |  */
14 | class Version
15 | {
16 |     /**
17 |      * Full version number.
18 |      */
19 |     const VERSION = '0.3.1';
20 | }
21 | 


--------------------------------------------------------------------------------
/phpstan.neon:
--------------------------------------------------------------------------------
1 | parameters:
2 |   level: 2
3 | 


--------------------------------------------------------------------------------
/tests/Xml/Atom/ParseAtomTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | namespace Sabre\Xml\Atom;
  6 | 
  7 | use PHPUnit\Framework\TestCase;
  8 | 
  9 | class ParseAtomTest extends TestCase
 10 | {
 11 |     public function testSimple()
 12 |     {
 13 |         $xml = <<<XML
 14 | <?xml version="1.0" encoding="utf-8"?>
 15 | <feed xmlns="http://www.w3.org/2005/Atom">
 16 | 
 17 |  <title>Example Feed</title>
 18 |  <link href="http://example.org/"/>
 19 |  <updated>2003-12-13T18:30:02Z</updated>
 20 |  <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
 21 |  <author>
 22 |    <name>John Doe</name>
 23 |  </author>
 24 | 
 25 | 
 26 |  <entry>
 27 |    <title>Atom-Powered Robots Run Amok</title>
 28 |    <link href="http://example.org/2003/12/13/atom03"/>
 29 |    <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
 30 |    <updated>2003-12-13T18:30:02Z</updated>
 31 |    <summary>Some text.</summary>
 32 |  </entry>
 33 | 
 34 | </feed>
 35 | XML;
 36 | 
 37 |         $feed = new Element\Feed();
 38 |         $feed->title = 'Example Feed';
 39 | 
 40 |         $link = new Element\Link();
 41 |         $link->href = 'http://example.org/';
 42 |         $feed->link[] = $link;
 43 | 
 44 |         $feed->updated = '2003-12-13T18:30:02Z';
 45 | 
 46 |         $author = new Element\Person();
 47 |         $author->name = 'John Doe';
 48 |         $feed->author[] = $author;
 49 | 
 50 |         $feed->id = 'urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6';
 51 | 
 52 |         $entry = new Element\Entry();
 53 |         $entry->title = 'Atom-Powered Robots Run Amok';
 54 | 
 55 |         $link = new Element\Link();
 56 |         $link->href = 'http://example.org/2003/12/13/atom03';
 57 |         $entry->link[] = $link;
 58 | 
 59 |         $entry->id = 'urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a';
 60 |         $entry->updated = '2003-12-13T18:30:02Z';
 61 |         $entry->summary = 'Some text.';
 62 | 
 63 |         $feed->entry[] = $entry;
 64 | 
 65 |         $this->assertRoundTrip($xml, $feed);
 66 |     }
 67 | 
 68 |     public function testExtensive()
 69 |     {
 70 |         $xml = <<<XML
 71 | <?xml version="1.0" encoding="utf-8"?>
 72 | <feed xmlns="http://www.w3.org/2005/Atom">
 73 |  <title>dive into mark</title>
 74 |  <subtitle>
 75 |    A &lt;em&gt;lot&lt;/em&gt; of effort
 76 |    went into making this effortless
 77 |  </subtitle>
 78 |  <link rel="alternate" type="text/html"
 79 |   hreflang="en" href="http://example.org/"/>
 80 |  <link rel="self" type="application/atom+xml"
 81 |   href="http://example.org/feed.atom"/>
 82 |  <updated>2005-07-31T12:29:29Z</updated>
 83 |  <id>tag:example.org,2003:3</id>
 84 |  <rights>Copyright (c) 2003, Mark Pilgrim</rights>
 85 |  <generator>
 86 |    Example Toolkit
 87 |  </generator>
 88 |  <entry>
 89 |    <title>Atom draft-07 snapshot</title>
 90 |    <link rel="alternate" type="text/html"
 91 |     href="http://example.org/2005/04/02/atom"/>
 92 |    <link rel="enclosure" type="audio/mpeg" length="1337"
 93 |     href="http://example.org/audio/ph34r_my_podcast.mp3"/>
 94 |    <id>tag:example.org,2003:3.2397</id>
 95 |    <updated>2005-07-31T12:29:29Z</updated>
 96 |    <published>2003-12-13T08:29:29-04:00</published>
 97 |    <author>
 98 |      <name>Mark Pilgrim</name>
 99 |      <uri>http://example.org/</uri>
100 |      <email>f8dy@example.com</email>
101 |    </author>
102 |    <contributor>
103 |      <name>Sam Ruby</name>
104 |    </contributor>
105 |    <contributor>
106 |      <name>Joe Gregorio</name>
107 |    </contributor>
108 |    <content>[Update: The Atom draft is finished.]</content>
109 |  </entry>
110 | </feed>
111 | XML;
112 | 
113 |         $this->assertRoundTrip($xml);
114 |     }
115 | 
116 |     /**
117 |      * Assets whether we can parse an xml feed and serialize it again and end
118 |      * up with a similar structure.
119 |      *
120 |      * If compareObject is specified, we'll also do a deep comparison of the
121 |      * parsed atom php object.
122 |      */
123 |     public function assertRoundTrip($xml, $compareObject = null)
124 |     {
125 |         $service = new Service();
126 | 
127 |         // Changing the default namespace prefix to an empty one, as the tests
128 |         // will be using that and it makes it easier to do comparisons.
129 |         $service->namespaceMap[Service::ATOM_NS] = '';
130 | 
131 |         $object = $service->parse($xml);
132 | 
133 |         if (!is_null($compareObject)) {
134 |             $this->assertEquals($compareObject, $object);
135 |         }
136 | 
137 |         $newXml = $service->writeValueObject($object);
138 |         $this->assertXmlStringEqualsXmlString($newXml, $xml);
139 |     }
140 | }
141 | 


--------------------------------------------------------------------------------
/tests/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <phpunit
 2 |   colors="true"
 3 |   bootstrap="../vendor/autoload.php"
 4 |   convertErrorsToExceptions="true"
 5 |   convertNoticesToExceptions="true"
 6 |   convertWarningsToExceptions="true"
 7 |   beStrictAboutTestsThatDoNotTestAnything="true"
 8 |   beStrictAboutOutputDuringTests="true"
 9 |   >
10 |   <testsuites>
11 |     <testsuite name="sabre-xml-atom">
12 |       <directory>.</directory>
13 |     </testsuite>
14 |   </testsuites>
15 | 
16 |   <filter>
17 |     <whitelist addUncoveredFilesFromWhitelist="true">
18 |         <directory suffix=".php">../lib/</directory>
19 |    </whitelist>
20 |   </filter>
21 | </phpunit>
22 | 


--------------------------------------------------------------------------------