]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/noticelistitem.php
Stronger typing for NoticeListItem and so
[quix0rs-gnu-social.git] / lib / noticelistitem.php
index 17827d07ef6b97f9c3f5898d19c0039491a15e68..f46827d1f739206881eb7784b9c6d63761f82d53 100644 (file)
@@ -4,7 +4,7 @@
  * Copyright (C) 2010, StatusNet, Inc.
  *
  * An item in a notice list
- * 
+ *
  * PHP version 5
  *
  * This program is free software: you can redistribute it and/or modify
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
-    // This check helps protect against security problems;
-    // your code file can't be executed directly from the web.
-    exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
  * widget for displaying a single notice
@@ -51,19 +47,15 @@ if (!defined('STATUSNET')) {
  * @see      NoticeList
  * @see      ProfileNoticeListItem
  */
-
 class NoticeListItem extends Widget
 {
     /** The notice this item will show. */
-
     var $notice = null;
 
     /** The notice that was repeated. */
-
     var $repeat = null;
 
     /** The profile of the author of the notice, extracted once for convenience. */
-
     var $profile = null;
 
     /**
@@ -73,12 +65,11 @@ class NoticeListItem extends Widget
      *
      * @param Notice $notice The notice we'll display
      */
-
-    function __construct($notice, $out=null)
+    function __construct(Notice $notice, HTMLOutputter $out=null)
     {
         parent::__construct($out);
         if (!empty($notice->repeat_of)) {
-            $original = Notice::staticGet('id', $notice->repeat_of);
+            $original = Notice::getKV('id', $notice->repeat_of);
             if (empty($original)) { // could have been deleted
                 $this->notice = $notice;
             } else {
@@ -99,7 +90,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function show()
     {
         if (empty($this->notice)) {
@@ -136,7 +126,9 @@ class NoticeListItem extends Widget
             $this->showNoticeLink();
             $this->showNoticeSource();
             $this->showNoticeLocation();
-            $this->showContext();
+            if ($this->notice->hasConversation()) {
+                $this->showContext();
+            }
             $this->showRepeat();
             Event::handle('EndShowNoticeInfo', array($this));
         }
@@ -150,10 +142,13 @@ class NoticeListItem extends Widget
             $user = common_current_user();
             if ($user) {
                 $this->out->elementStart('div', 'notice-options');
-                $this->showFaveForm();
-                $this->showReplyLink();
-                $this->showRepeatForm();
-                $this->showDeleteLink();
+                if (Event::handle('StartShowNoticeOptionItems', array($this))) {
+                    $this->showFaveForm();
+                    $this->showReplyLink();
+                    $this->showRepeatForm();
+                    $this->showDeleteLink();
+                    Event::handle('EndShowNoticeOptionItems', array($this));
+                }
                 $this->out->elementEnd('div');
             }
             Event::handle('EndShowNoticeOptions', array($this));
@@ -165,12 +160,18 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showStart()
     {
         if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
             $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
-            $this->out->elementStart('li', array('class' => 'hentry notice',
+            $class = 'hentry notice';
+            if ($this->notice->scope != 0 && $this->notice->scope != 1) {
+                $class .= ' limited-scope';
+            }
+            if (!empty($this->notice->source)) {
+                $class .= ' notice-source-'.$this->notice->source;
+            }
+            $this->out->elementStart('li', array('class' => $class,
                                                  'id' => 'notice-' . $id));
             Event::handle('EndOpenNoticeListItemElement', array($this));
         }
@@ -181,7 +182,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showFaveForm()
     {
         if (Event::handle('StartShowFaveForm', array($this))) {
@@ -209,18 +209,70 @@ class NoticeListItem extends Widget
 
     function showAuthor()
     {
+        $this->out->elementStart('div', 'author');
+
         $this->out->elementStart('span', 'vcard author');
+
         $attrs = array('href' => $this->profile->profileurl,
-                       'class' => 'url');
-        if (!empty($this->profile->fullname)) {
-            $attrs['title'] = $this->profile->getFancyName();
-        }
+                       'class' => 'url',
+                       'title' => $this->profile->nickname);
+
         $this->out->elementStart('a', $attrs);
         $this->showAvatar();
         $this->out->text(' ');
-        $this->showNickname();
+        $this->out->element('span',array('class' => 'fn'), $this->profile->getStreamName());
         $this->out->elementEnd('a');
+
         $this->out->elementEnd('span');
+
+        $this->showAddressees();
+
+        $this->out->elementEnd('div');
+    }
+
+    function showAddressees()
+    {
+        $pa = $this->getProfileAddressees();
+
+        if (!empty($pa)) {
+            $this->out->elementStart('span', 'addressees');
+            $first = true;
+            foreach ($pa as $addr) {
+                if (!$first) {
+                    // TRANS: Separator in profile addressees list.
+                    $this->out->text(_m('SEPARATOR',', '));
+                } else {
+                    // Start of profile addressees list.
+                    $first = false;
+                }
+                $text = $addr['text'];
+                unset($addr['text']);
+                $this->out->element('a', $addr, $text);
+            }
+            $this->out->elementEnd('span', 'addressees');
+        }
+    }
+
+    function getProfileAddressees()
+    {
+        $pa = array();
+
+        $attentions = $this->getReplyProfiles();
+
+        foreach ($attentions as $attn) {
+            $class = $attn->isGroup() ? 'group' : 'account';
+            $pa[] = array('href' => $attn->profileurl,
+                          'title' => $attn->nickname,
+                          'class' => "addressee {$class}",
+                          'text' => $attn->getStreamName());
+        }
+
+        return $pa;
+    }
+
+    function getReplyProfiles()
+    {
+        return $this->notice->getReplyProfiles();
     }
 
     /**
@@ -231,16 +283,13 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showAvatar()
     {
         $avatar_size = $this->avatarSize();
 
-        $avatar = $this->profile->getAvatar($avatar_size);
+        $avatarUrl = $this->profile->avatarUrl($avatar_size);
 
-        $this->out->element('img', array('src' => ($avatar) ?
-                                         $avatar->displayUrl() :
-                                         Avatar::defaultImage($avatar_size),
+        $this->out->element('img', array('src' => $avatarUrl,
                                          'class' => 'avatar photo',
                                          'width' => $avatar_size,
                                          'height' => $avatar_size,
@@ -262,7 +311,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showNickname()
     {
         $this->out->raw('<span class="nickname fn">' .
@@ -279,7 +327,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showContent()
     {
         // FIXME: URL, image, video, audio
@@ -305,26 +352,19 @@ class NoticeListItem extends Widget
     /**
      * show the link to the main page for the notice
      *
-     * Displays a link to the page for a notice, with "relative" time. Tries to
-     * get remote notice URLs correct, but doesn't always succeed.
+     * Displays a local link to the rendered notice, with "relative" time.
      *
      * @return void
      */
-
     function showNoticeLink()
     {
-        $noticeurl = $this->notice->bestUrl();
-
-        // above should always return an URL
-
-        assert(!empty($noticeurl));
-
         $this->out->elementStart('a', array('rel' => 'bookmark',
                                             'class' => 'timestamp',
-                                            'href' => $noticeurl));
-        $dt = common_date_iso8601($this->notice->created);
-        $this->out->element('abbr', array('class' => 'published',
-                                          'title' => $dt),
+                                            'href' => $this->notice->getLocalUrl()));
+        $this->out->element('time', array('class' => 'dt-published',
+                                          'datetime' => common_date_iso8601($this->notice->created),
+                                          // TRANS: Timestamp title (tooltip text) for NoticeListItem
+                                          'title' => common_exact_date($this->notice->created)),
                             common_date_string($this->notice->created));
         $this->out->elementEnd('a');
     }
@@ -338,7 +378,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showNoticeLocation()
     {
         $id = $this->notice->id;
@@ -358,15 +397,20 @@ class NoticeListItem extends Widget
         if (empty($name)) {
             $latdms = $this->decimalDegreesToDMS(abs($lat));
             $londms = $this->decimalDegreesToDMS(abs($lon));
-            // TRANS: Used in coordinates as abbreviation of north
+            // TRANS: Used in coordinates as abbreviation of north.
             $north = _('N');
-            // TRANS: Used in coordinates as abbreviation of south
+            // TRANS: Used in coordinates as abbreviation of south.
             $south = _('S');
-            // TRANS: Used in coordinates as abbreviation of east
+            // TRANS: Used in coordinates as abbreviation of east.
             $east = _('E');
-            // TRANS: Used in coordinates as abbreviation of west
+            // TRANS: Used in coordinates as abbreviation of west.
             $west = _('W');
             $name = sprintf(
+                // TRANS: Coordinates message.
+                // TRANS: %1$s is lattitude degrees, %2$s is lattitude minutes,
+                // TRANS: %3$s is lattitude seconds, %4$s is N (north) or S (south) depending on lattitude,
+                // TRANS: %5$s is longitude degrees, %6$s is longitude minutes,
+                // TRANS: %7$s is longitude seconds, %8$s is E (east) or W (west) depending on longitude,
                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
@@ -376,6 +420,7 @@ class NoticeListItem extends Widget
 
         $this->out->text(' ');
         $this->out->elementStart('span', array('class' => 'location'));
+        // TRANS: Followed by geo location.
         $this->out->text(_('at'));
         $this->out->text(' ');
         if (empty($url)) {
@@ -419,16 +464,17 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showNoticeSource()
     {
         $ns = $this->notice->getSource();
 
         if ($ns) {
-            $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _('web')) : _($ns->name);
+            // TRANS: A possible notice source (web interface).
+            $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
             $this->out->text(' ');
             $this->out->elementStart('span', 'source');
-            // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
+            // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
+            // TRANS: Followed by notice source.
             $this->out->text(_('from'));
             $this->out->text(' ');
 
@@ -445,7 +491,6 @@ class NoticeListItem extends Widget
             // if $ns->name and $ns->url are populated we have
             // configured a source attr somewhere
             if (!empty($name) && !empty($url)) {
-
                 $this->out->elementStart('span', 'device');
 
                 $attrs = array(
@@ -475,34 +520,13 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showContext()
     {
-        if ($this->notice->hasConversation()) {
-            $conv = Conversation::staticGet(
-                'id',
-                $this->notice->conversation
-            );
-            $convurl = $conv->uri;
-            if (!empty($convurl)) {
-                $this->out->text(' ');
-                $this->out->element(
-                    'a',
-                    array(
-                    'href' => $convurl.'#notice-'.$this->notice->id,
-                    'class' => 'response'),
-                    _('in context')
-                );
-            } else {
-                $msg = sprintf(
-                    "Couldn't find Conversation ID %d to make 'in context'"
-                    . "link for Notice ID %d",
-                    $this->notice->conversation,
-                    $this->notice->id
-                );
-                common_log(LOG_WARNING, $msg);
-            }
-        }
+        $this->out->element('a',
+                            array('href' => $this->notice->getConversationUrl(),
+                                  'class' => 'conversation'),
+                            // TRANS: Addition in notice list item if notice is part of a conversation.
+                            _('in context'));
     }
 
     /**
@@ -510,12 +534,11 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showRepeat()
     {
         if (!empty($this->repeat)) {
 
-            $repeater = Profile::staticGet('id', $this->repeat->profile_id);
+            $repeater = Profile::getKV('id', $this->repeat->profile_id);
 
             $attrs = array('href' => $repeater->profileurl,
                            'class' => 'url');
@@ -526,7 +549,9 @@ class NoticeListItem extends Widget
 
             $this->out->elementStart('span', 'repeat vcard');
 
+            // TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
             $this->out->raw(_('Repeated by'));
+            $this->out->raw(' ');
 
             $this->out->elementStart('a', $attrs);
             $this->out->element('span', 'fn nickname', $repeater->nickname);
@@ -544,7 +569,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showReplyLink()
     {
         if (common_logged_in()) {
@@ -553,7 +577,9 @@ class NoticeListItem extends Widget
                                           array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
             $this->out->elementStart('a', array('href' => $reply_url,
                                                 'class' => 'notice_reply',
-                                                'title' => _('Reply to this notice')));
+                                                // TRANS: Link title in notice list item to reply to a notice.
+                                                'title' => _('Reply to this notice.')));
+            // TRANS: Link text in notice list item to reply to a notice.
             $this->out->text(_('Reply'));
             $this->out->text(' ');
             $this->out->element('span', 'notice_id', $this->notice->id);
@@ -566,7 +592,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showDeleteLink()
     {
         $user = common_current_user();
@@ -580,7 +605,10 @@ class NoticeListItem extends Widget
                                           array('notice' => $todel->id));
             $this->out->element('a', array('href' => $deleteurl,
                                            'class' => 'notice_delete',
-                                           'title' => _('Delete this notice')), _('Delete'));
+                                           // TRANS: Link title in notice list item to delete a notice.
+                                           'title' => _('Delete this notice from the timeline.')),
+                                           // TRANS: Link text in notice list item to delete a notice.
+                                           _('Delete'));
         }
     }
 
@@ -589,20 +617,25 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showRepeatForm()
     {
-        $user = common_current_user();
-        if ($user && $user->id != $this->notice->profile_id) {
-            $this->out->text(' ');
-            $profile = $user->getProfile();
-            if ($profile->hasRepeated($this->notice->id)) {
-                $this->out->element('span', array('class' => 'repeated',
-                                                  'title' => _('Notice repeated')),
-                                            _('Repeated'));
-            } else {
-                $rf = new RepeatForm($this->out, $this->notice);
-                $rf->show();
+        if ($this->notice->scope == Notice::PUBLIC_SCOPE ||
+            $this->notice->scope == Notice::SITE_SCOPE) {
+            $user = common_current_user();
+            if (!empty($user) &&
+                $user->id != $this->notice->profile_id) {
+                $this->out->text(' ');
+                $profile = $user->getProfile();
+                if ($profile->hasRepeated($this->notice)) {
+                    $this->out->element('span', array('class' => 'repeated',
+                                                      // TRANS: Title for repeat form status in notice list when a notice has been repeated.
+                                                      'title' => _('Notice repeated.')),
+                                        // TRANS: Repeat form status in notice list when a notice has been repeated.
+                                        _('Repeated'));
+                } else {
+                    $rf = new RepeatForm($this->out, $this->notice);
+                    $rf->show();
+                }
             }
         }
     }
@@ -614,7 +647,6 @@ class NoticeListItem extends Widget
      *
      * @return void
      */
-
     function showEnd()
     {
         if (Event::handle('StartCloseNoticeListItemElement', array($this))) {
@@ -622,4 +654,17 @@ class NoticeListItem extends Widget
             Event::handle('EndCloseNoticeListItemElement', array($this));
         }
     }
+
+    /**
+     * Get the notice in question
+     *
+     * For hooks, etc., this may be useful
+     *
+     * @return Notice The notice we're showing
+     */
+
+    function getNotice()
+    {
+        return $this->notice;
+    }
 }