3 * Laconica, the distributed open-source microblogging tool
5 * widget for displaying a list of notice attachments
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.
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.
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/>.
24 * @author Evan Prodromou <evan@controlyourself.ca>
25 * @author Sarven Capadisli <csarven@controlyourself.ca>
26 * @copyright 2008 Control Yourself, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://laconi.ca/
31 if (!defined('LACONICA')) {
36 * widget for displaying a list of notice attachments
38 * There are a number of actions that display a list of notices, in
39 * reverse chronological order. This widget abstracts out most of the
40 * code for UI for notice lists. It's overridden to hide some
41 * data for e.g. the profile page.
45 * @author Evan Prodromou <evan@controlyourself.ca>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://laconi.ca/
50 * @see ProfileNoticeList
53 class AttachmentList extends Widget
55 /** the current stream of notices being displayed. */
62 * @param Notice $notice stream of notices from DB_DataObject
65 function __construct($notice, $out=null)
67 parent::__construct($out);
68 $this->notice = $notice;
72 * show the list of notices
74 * "Uses up" the stream by looping through it. So, probably can't
75 * be called twice on the same list.
77 * @return int count of notices listed.
83 $att = $atts->getAttachments($this->notice->id);
84 if (empty($att)) return 0;
85 $this->out->elementStart('dl', array('id' =>'attachments'));
86 $this->out->element('dt', null, _('Attachments'));
87 $this->out->elementStart('dd');
88 $this->out->elementStart('ol', array('class' => 'attachments'));
90 foreach ($att as $n=>$attachment) {
91 $item = $this->newListItem($attachment);
95 $this->out->elementEnd('dd');
96 $this->out->elementEnd('ol');
97 $this->out->elementEnd('dl');
103 * returns a new list item for the current notice
105 * Recipe (factory?) method; overridden by sub-classes to give
106 * a different list item class.
108 * @param Notice $notice the current notice
110 * @return NoticeListItem a list item for displaying the notice
113 function newListItem($attachment)
115 return new AttachmentListItem($attachment, $this->out);
120 * widget for displaying a single notice
122 * This widget has the core smarts for showing a single notice: what to display,
123 * where, and under which circumstances. Its key method is show(); this is a recipe
124 * that calls all the other show*() methods to build up a single notice. The
125 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
126 * author info (since that's implicit by the data in the page).
130 * @author Evan Prodromou <evan@controlyourself.ca>
131 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
132 * @link http://laconi.ca/
134 * @see ProfileNoticeListItem
137 class AttachmentListItem extends Widget
139 /** The attachment this item will show. */
141 var $attachment = null;
148 * Also initializes the profile attribute.
150 * @param Notice $notice The notice we'll display
153 function __construct($attachment, $out=null)
155 parent::__construct($out);
156 $this->attachment = $attachment;
157 $this->oembed = File_oembed::staticGet('file_id', $this->attachment->id);
161 if (empty($this->attachment->title)) {
162 if (empty($this->oembed->title)) {
163 $title = $this->attachment->url;
165 $title = $this->oembed->title;
168 $title = $this->attachment->title;
174 function linkTitle() {
175 return $this->title();
179 * recipe function for displaying a single notice.
181 * This uses all the other methods to correctly display a notice. Override
182 * it or one of the others to fine-tune the output.
190 $this->showNoticeAttachment();
194 function linkAttr() {
195 return array('class' => 'attachment', 'href' => $this->attachment->url, 'id' => 'attachment-' . $this->attachment->id);
198 function showLink() {
199 $this->out->elementStart('a', $this->linkAttr());
200 $this->out->element('span', null, $this->linkTitle());
201 $this->showRepresentation();
202 $this->out->elementEnd('a');
205 function showNoticeAttachment()
210 function showRepresentation() {
211 $thumbnail = File_thumbnail::staticGet('file_id', $this->attachment->id);
212 if (!empty($thumbnail)) {
213 $this->out->element('img', array('alt' => 'nothing to say', 'src' => $thumbnail->url, 'width' => $thumbnail->width, 'height' => $thumbnail->height));
218 * start a single notice.
226 // TODO: add notice_type class e.g., notice_video, notice_image
227 $this->out->elementStart('li');
233 * Close the last elements in the notice list item
240 $this->out->elementEnd('li');
244 class Attachment extends AttachmentListItem
247 $this->showNoticeAttachment();
250 function linkAttr() {
251 return array('class' => 'external', 'href' => $this->attachment->url);
254 function linkTitle() {
255 return $this->attachment->url;
258 function showRepresentation() {
259 if (empty($this->oembed->type)) {
260 if (empty($this->attachment->mimetype)) {
261 $this->out->element('pre', null, 'oh well... not sure how to handle the following: ' . print_r($this->attachment, true));
263 switch ($this->attachment->mimetype) {
268 $this->out->element('img', array('src' => $this->attachment->url, 'alt' => 'alt'));
271 case 'application/ogg':
272 case 'audio/x-speex':
276 case 'video/quicktime':
277 $arr = array('type' => $this->attachment->mimetype,
278 'data' => $this->attachment->url,
282 $this->out->elementStart('object', $arr);
283 $this->out->element('param', array('name' => 'src', 'value' => $this->attachment->url));
284 $this->out->element('param', array('name' => 'autoStart', 'value' => 1));
285 $this->out->elementEnd('object');
290 switch ($this->oembed->type) {
294 if (!empty($this->oembed->html)) {
295 $this->out->raw($this->oembed->html);
300 $this->out->element('img', array('src' => $this->oembed->url, 'width' => $this->oembed->width, 'height' => $this->oembed->height, 'alt' => 'alt'));
304 $this->out->element('pre', null, 'oh well... not sure how to handle the following oembed: ' . print_r($this->oembed, true));