lib/attachmentlistitem.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * widget for displaying a list of notice attachments
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  UI
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008 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('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * widget for displaying a single notice
  35  *
  36  * This widget has the core smarts for showing a single notice: what to display,
  37  * where, and under which circumstances. Its key method is show(); this is a recipe
  38  * that calls all the other show*() methods to build up a single notice. The
  39  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
  40  * author info (since that's implicit by the data in the page).
  41  *
  42  * @category UI
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  46  * @link     http://status.net/
  47  * @see      NoticeList
  48  * @see      ProfileNoticeListItem
  49  */
  50 class AttachmentListItem extends Widget
  51 {
  52     /** The attachment this item will show. */
  53
  54     var $attachment = null;
  55
  56     /**
  57      * @param File $attachment the attachment we will display
  58      */
  59     function __construct(File $attachment, $out=null)
  60     {
  61         parent::__construct($out);
  62         $this->attachment  = $attachment;
  63     }
  64
  65     function title() {
  66         return $this->attachment->title ?: $this->attachment->filename;
  67     }
  68
  69     function linkTitle() {
  70         return $this->title();
  71     }
  72
  73     /**
  74      * recipe function for displaying a single notice.
  75      *
  76      * This uses all the other methods to correctly display a notice. Override
  77      * it or one of the others to fine-tune the output.
  78      *
  79      * @return void
  80      */
  81     function show()
  82     {
  83         $this->showStart();
  84         $this->showNoticeAttachment();
  85         $this->showEnd();
  86     }
  87
  88     function linkAttr() {
  89         return array('class' => 'attachment',
  90                      'href' => $this->attachment->url,
  91                      'id' => 'attachment-' . $this->attachment->id,
  92                      'title' => $this->linkTitle());
  93     }
  94
  95     function showLink() {
  96         $this->out->elementStart('a', $this->linkAttr());
  97         $this->out->element('span', null, $this->linkTitle());
  98         $this->showRepresentation();
  99         $this->out->elementEnd('a');
 100     }
 101
 102     function showNoticeAttachment()
 103     {
 104         $this->showLink();
 105     }
 106
 107     function showRepresentation() {
 108         try {
 109             $thumb = $this->attachment->getThumbnail();
 110             $this->out->element('img', array('alt' => '', 'src' => $thumb->getUrl(), 'width' => $thumb->width, 'height' => $thumb->height));
 111         } catch (UnsupportedMediaException $e) {
 112             // Image representation unavailable
 113         }
 114     }
 115
 116     /**
 117      * start a single notice.
 118      *
 119      * @return void
 120      */
 121     function showStart()
 122     {
 123         // XXX: RDFa
 124         // TODO: add notice_type class e.g., notice_video, notice_image
 125         $this->out->elementStart('li');
 126     }
 127
 128     /**
 129      * finish the notice
 130      *
 131      * Close the last elements in the notice list item
 132      *
 133      * @return void
 134      */
 135     function showEnd()
 136     {
 137         $this->out->elementEnd('li');
 138     }
 139 }