lib/atomusernoticefeed.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Class for building an in-memory Atom feed for a particular user's
   6  * timeline.
   7  *
   8  * PHP version 5
   9  *
  10  * LICENCE: 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  Feed
  24  * @package   StatusNet
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET'))
  32 {
  33     exit(1);
  34 }
  35
  36 /**
  37  * Class for user notice feeds.  May contain a reference to the user.
  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 AtomUserNoticeFeed extends AtomNoticeFeed
  46 {
  47     private $user;
  48
  49     /**
  50      * Constructor
  51      *
  52      * @param User    $user    the user for the feed
  53      * @param boolean $indent  flag to turn indenting on or off
  54      *
  55      * @return void
  56      */
  57
  58     function __construct($user, $indent = true) {
  59         parent::__construct($indent);
  60         $this->user = $user;
  61         if (!empty($user)) {
  62             $profile = $user->getProfile();
  63             $this->addAuthor($profile->nickname, $user->uri);
  64             $this->setActivitySubject($profile->asActivityNoun('subject'));
  65         }
  66
  67         // TRANS: Title in atom user notice feed. %s is a user name.
  68         $title      = sprintf(_("%s timeline"), $user->nickname);
  69         $this->setTitle($title);
  70
  71         $sitename   = common_config('site', 'name');
  72         $subtitle   = sprintf(
  73             // TRANS: Message is used as a subtitle in atom user notice feed.
  74             // TRANS: %1$s is a user name, %2$s is a site name.
  75             _('Updates from %1$s on %2$s!'),
  76             $user->nickname, $sitename
  77         );
  78         $this->setSubtitle($subtitle);
  79
  80         $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
  81         $logo = ($avatar) ? $avatar->displayUrl() : Avatar::defaultImage(AVATAR_PROFILE_SIZE);
  82         $this->setLogo($logo);
  83
  84         $this->setUpdated('now');
  85
  86         $this->addLink(
  87             common_local_url(
  88                 'showstream',
  89                 array('nickname' => $user->nickname)
  90             )
  91         );
  92
  93         $self = common_local_url('ApiTimelineUser',
  94                                  array('id' => $user->id,
  95                                        'format' => 'atom'));
  96         $this->setId($self);
  97         $this->setSelfLink($self);
  98
  99         $this->addLink(
 100             common_local_url('sup', null, null, $user->id),
 101             array(
 102                 'rel' => 'http://api.friendfeed.com/2008/03#sup',
 103                 'type' => 'application/json'
 104             )
 105         );
 106     }
 107
 108     function getUser()
 109     {
 110         return $this->user;
 111     }
 112
 113     function showSource()
 114     {
 115         return false;
 116     }
 117
 118     function showAuthor()
 119     {
 120         return false;
 121     }
 122 }