lib/attachmentlist.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 list of notice attachments
  35  *
  36  * There are a number of actions that display a list of notices, in
  37  * reverse chronological order. This widget abstracts out most of the
  38  * code for UI for notice lists. It's overridden to hide some
  39  * data for e.g. the profile page.
  40  *
  41  * @category UI
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  * @see      Notice
  47  * @see      NoticeListItem
  48  * @see      ProfileNoticeList
  49  */
  50 class AttachmentList extends Widget
  51 {
  52     /** the current stream of notices being displayed. */
  53
  54     var $notice = null;
  55
  56     /**
  57      * constructor
  58      *
  59      * @param Notice $notice stream of notices from DB_DataObject
  60      */
  61     function __construct(Notice $notice, $out=null)
  62     {
  63         parent::__construct($out);
  64         $this->notice = $notice;
  65     }
  66
  67     /**
  68      * show the list of attachments
  69      *
  70      * "Uses up" the stream by looping through it. So, probably can't
  71      * be called twice on the same list.
  72      *
  73      * @return int count of items listed.
  74      */
  75     function show()
  76     {
  77         $attachments = $this->notice->attachments();
  78         foreach ($attachments as $key=>$att) {
  79             // Only show attachments representable with a title
  80             if ($att->getTitle() === null) {
  81                 unset($attachments[$key]);
  82             }
  83         }
  84         if (!count($attachments)) {
  85             return 0;
  86         }
  87
  88         $this->showListStart();
  89
  90         foreach ($attachments as $att) {
  91             $item = $this->newListItem($att);
  92             $item->show();
  93         }
  94
  95         $this->showListEnd();
  96
  97         return count($attachments);
  98     }
  99
 100     function showListStart()
 101     {
 102         $this->out->elementStart('ol', array('class' => 'attachments'));
 103     }
 104
 105     function showListEnd()
 106     {
 107         $this->out->elementEnd('ol');
 108     }
 109
 110     /**
 111      * returns a new list item for the current attachment
 112      *
 113      * @param File $attachment the current attachment
 114      *
 115      * @return AttachmentListItem a list item for displaying the attachment
 116      */
 117     function newListItem(File $attachment)
 118     {
 119         return new AttachmentListItem($attachment, $this->out);
 120     }
 121 }