lib/threadingnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Notice stream that's good for threading lists
   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  Notice 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  * This notice stream filters notices by whether their conversation
  39  * has been seen before. It's a good (well, OK) way to get streams
  40  * for a ThreadedNoticeList display.
  41  *
  42  * @category  Notice stream
  43  * @package   StatusNet
  44  * @author    Evan Prodromou <evan@status.net>
  45  * @copyright 2011 StatusNet, Inc.
  46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  47  * @link      http://status.net/
  48  */
  49
  50 class ThreadingNoticeStream extends FilteringNoticeStream
  51 {
  52     protected $seen = array();
  53
  54     function getNotices($offset, $limit, $sinceId=null, $maxId=null)
  55     {
  56         // Clear this each time we're called
  57         $this->seen = array();
  58         return parent::getNotices($offset, $limit, $sinceId, $maxId);
  59     }
  60
  61     function filter($notice)
  62     {
  63         if (!array_key_exists($notice->conversation, $this->seen)) {
  64             $this->seen[$notice->conversation] = true;
  65             return true;
  66         } else {
  67             return false;
  68         }
  69     }
  70 }