Prefill done by notice stream
[statusnet:anarcat-sandbox.git] / lib / scopingnoticestream.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2011, StatusNet, Inc.
5  *
6  * Filtering notice stream that recognizes notice scope
7  * 
8  * PHP version 5
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Affero General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Affero General Public License for more details.
19  *
20  * You should have received a copy of the GNU Affero General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  * @category  Stream
24  * @package   StatusNet
25  * @author    Evan Prodromou <evan@status.net>
26  * @copyright 2011 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('STATUSNET')) {
32     // This check helps protect against security problems;
33     // your code file can't be executed directly from the web.
34     exit(1);
35 }
36
37 /**
38  * Class comment
39  *
40  * @category  Stream
41  * @package   StatusNet
42  * @author    Evan Prodromou <evan@status.net>
43  * @copyright 2011 StatusNet, Inc.
44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
45  * @link      http://status.net/
46  */
47
48 class ScopingNoticeStream extends FilteringNoticeStream
49 {
50     protected $profile;
51
52     function __construct($upstream, $profile = -1)
53     {
54         parent::__construct($upstream);
55
56         // Invalid but not null
57         if (is_int($profile) && $profile == -1) {
58             $profile = Profile::current();
59         }
60
61         $this->profile = $profile;
62     }
63
64     /**
65      * Only return notices where the profile is in scope
66      *
67      * @param Notice $notice The notice to check
68      *
69      * @return boolean whether to include the notice
70      */
71
72     function filter($notice)
73     {
74         return $notice->inScope($this->profile);
75     }
76
77     function prefill($notices)
78     {
79         // XXX: this should probably only be in the scoping one.
80             
81         Notice::fillGroups($notices);
82         Notice::fillReplies($notices);
83     }
84 }