lib/noticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A stream of notices
   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 for notice streams
  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 abstract class NoticeStream
  48 {
  49     abstract function getNoticeIds($offset, $limit, $since_id, $max_id);
  50
  51     function getNotices($offset, $limit, $sinceId = null, $maxId = null)
  52     {
  53         $ids = $this->getNoticeIds($offset, $limit, $sinceId, $maxId);
  54
  55         $notices = self::getStreamByIds($ids);
  56
  57         return $notices;
  58     }
  59
  60     static function getStreamByIds($ids)
  61     {
  62         $cache = Cache::instance();
  63
  64         if (!empty($cache)) {
  65             $notices = array();
  66             foreach ($ids as $id) {
  67                 $n = Notice::staticGet('id', $id);
  68                 if (!empty($n)) {
  69                     $notices[] = $n;
  70                 }
  71             }
  72             return new ArrayWrapper($notices);
  73         } else {
  74             $notice = new Notice();
  75             if (empty($ids)) {
  76                 //if no IDs requested, just return the notice object
  77                 return $notice;
  78             }
  79             $notice->whereAdd('id in (' . implode(', ', $ids) . ')');
  80
  81             $notice->find();
  82
  83             $temp = array();
  84
  85             while ($notice->fetch()) {
  86                 $temp[$notice->id] = clone($notice);
  87             }
  88
  89             $wrapped = array();
  90
  91             foreach ($ids as $id) {
  92                 if (array_key_exists($id, $temp)) {
  93                     $wrapped[] = $temp[$id];
  94                 }
  95             }
  96
  97             return new ArrayWrapper($wrapped);
  98         }
  99     }
 100 }