]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/atomnoticefeed.php
Same goes to onStartShowAside() which has 'Action' as type-hint.
[quix0rs-gnu-social.git] / lib / atomnoticefeed.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Class for building an Atom feed from a collection of notices
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Feed
23  * @package   StatusNet
24  * @author    Zach Copley <zach@status.net>
25  * @copyright 2010 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29
30 if (!defined('STATUSNET'))
31 {
32     exit(1);
33 }
34
35 /**
36  * Class for creating a feed that represents a collection of notices. Builds the
37  * feed in memory. Get the feed as a string with AtomNoticeFeed::getString().
38  *
39  * @category Feed
40  * @package  StatusNet
41  * @author   Zach Copley <zach@status.net>
42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43  * @link     http://status.net/
44  */
45 class AtomNoticeFeed extends Atom10Feed
46 {
47     var $cur;
48     protected $scoped=null;
49
50     /**
51      * Constructor - adds a bunch of XML namespaces we need in our
52      * notice-specific Atom feeds, and allows setting the current
53      * authenticated user (useful for API methods).
54      *
55      * @param User    $cur     the current authenticated user (optional)
56      * @param boolean $indent  Whether to indent XML output
57      *
58      */
59     function __construct($cur = null, $indent = true) {
60         parent::__construct($indent);
61
62         $this->cur = $cur ?: common_current_user();
63         $this->scoped = !is_null($this->cur) ? $this->cur->getProfile() : null;
64
65         // Feeds containing notice info use these namespaces
66
67         $this->addNamespace(
68             'thr',
69             'http://purl.org/syndication/thread/1.0'
70         );
71
72         $this->addNamespace(
73             'georss',
74             'http://www.georss.org/georss'
75         );
76
77         $this->addNamespace(
78             'activity',
79             'http://activitystrea.ms/spec/1.0/'
80         );
81
82         $this->addNamespace(
83             'media',
84             'http://purl.org/syndication/atommedia'
85         );
86
87         $this->addNamespace(
88             'poco',
89             'http://portablecontacts.net/spec/1.0'
90         );
91
92         // XXX: What should the uri be?
93         $this->addNamespace(
94             'ostatus',
95             'http://ostatus.org/schema/1.0'
96         );
97
98         $this->addNamespace(
99             'statusnet',
100             'http://status.net/schema/api/1/'
101         );
102     }
103
104     /**
105      * Add more than one Notice to the feed
106      *
107      * @param mixed $notices an array of Notice objects or handle
108      *
109      */
110     function addEntryFromNotices($notices)
111     {
112         if (is_array($notices)) {
113             foreach ($notices as $notice) {
114                 $this->addEntryFromNotice($notice);
115             }
116         } else {
117             while ($notices->fetch()) {
118                 $this->addEntryFromNotice($notices);
119             }
120         }
121     }
122
123     /**
124      * Add a single Notice to the feed
125      *
126      * @param Notice $notice a Notice to add
127      */
128     function addEntryFromNotice($notice)
129     {
130         try {
131             $source = $this->showSource();
132             $author = $this->showAuthor();
133
134             $this->addEntryRaw($notice->asAtomEntry(false, $source, $author, $this->scoped));
135         } catch (Exception $e) {
136             common_log(LOG_ERR, $e->getMessage());
137             // we continue on exceptions
138         }
139     }
140
141     function showSource()
142     {
143         return true;
144     }
145
146     function showAuthor()
147     {
148         return true;
149     }
150 }