gnu-social/lib/noticelist.php
2014-06-02 00:20:27 +02:00

149 lines
4.5 KiB
PHP

<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* widget for displaying a list of notices
*
* PHP version 5
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category UI
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @author Sarven Capadisli <csarven@status.net>
* @copyright 2008 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
/**
* widget for displaying a list of notices
*
* There are a number of actions that display a list of notices, in
* reverse chronological order. This widget abstracts out most of the
* code for UI for notice lists. It's overridden to hide some
* data for e.g. the profile page.
*
* @category UI
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
* @see Notice
* @see NoticeListItem
* @see ProfileNoticeList
*/
class NoticeList extends Widget
{
/** the current stream of notices being displayed. */
var $notice = null;
/**
* constructor
*
* @param Notice $notice stream of notices from DB_DataObject
*/
function __construct(Notice $notice, $out=null)
{
parent::__construct($out);
$this->notice = $notice;
}
/**
* show the list of notices
*
* "Uses up" the stream by looping through it. So, probably can't
* be called twice on the same list.
*
* @return int count of notices listed.
*/
function show()
{
$this->out->elementStart('div', array('id' =>'notices_primary'));
$this->out->elementStart('ol', array('class' => 'notices xoxo'));
$notices = $this->notice->fetchAll();
$total = count($notices);
$notices = array_slice($notices, 0, NOTICES_PER_PAGE);
self::prefill($notices);
foreach ($notices as $notice) {
try {
$item = $this->newListItem($notice);
$item->show();
} catch (Exception $e) {
// we log exceptions and continue
common_log(LOG_ERR, $e->getMessage());
continue;
}
}
$this->out->elementEnd('ol');
$this->out->elementEnd('div');
return $total;
}
/**
* returns a new list item for the current notice
*
* Recipe (factory?) method; overridden by sub-classes to give
* a different list item class.
*
* @param Notice $notice the current notice
*
* @return NoticeListItem a list item for displaying the notice
*/
function newListItem(Notice $notice)
{
return new NoticeListItem($notice, $this->out);
}
static function prefill(&$notices, $avatarSize=AVATAR_STREAM_SIZE)
{
if (Event::handle('StartNoticeListPrefill', array(&$notices, $avatarSize))) {
// Prefill attachments
Notice::fillAttachments($notices);
// Prefill attachments
Notice::fillFaves($notices);
// Prefill repeat data
Notice::fillRepeats($notices);
// Prefill the profiles
$profiles = Notice::fillProfiles($notices);
$p = Profile::current();
if ($p instanceof Profile) {
$ids = array();
foreach ($notices as $notice) {
$ids[] = $notice->id;
}
Fave::pivotGet('notice_id', $ids, array('user_id' => $p->id));
Notice::pivotGet('repeat_of', $ids, array('profile_id' => $p->id));
}
Event::handle('EndNoticeListPrefill', array(&$notices, &$profiles, $avatarSize));
}
}
}