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/
51 * @see ProfileNoticeList
54 class AttachmentList extends Widget
56 /** the current stream of notices being displayed. */
63 * @param Notice $notice stream of notices from DB_DataObject
66 function __construct($notice, $out=null)
68 parent::__construct($out);
69 $this->notice = $notice;
73 * show the list of notices
75 * "Uses up" the stream by looping through it. So, probably can't
76 * be called twice on the same list.
78 * @return int count of notices listed.
84 $att = $atts->getAttachments($this->notice->id);
85 if (empty($att)) return 0;
87 $this->out->elementStart('dl', array('id' =>'attachment'));
88 $this->out->element('dt', null, _('Attachments'));
89 $this->out->elementStart('dd');
90 $this->out->elementStart('ul', array('class' => 'attachments'));
92 foreach ($att as $n=>$attachment) {
93 $item = $this->newListItem($attachment);
97 $this->out->elementEnd('dd');
98 $this->out->elementEnd('ul');
99 $this->out->elementEnd('dl');
105 * returns a new list item for the current notice
107 * Recipe (factory?) method; overridden by sub-classes to give
108 * a different list item class.
110 * @param Notice $notice the current notice
112 * @return NoticeListItem a list item for displaying the notice
115 function newListItem($attachment)
117 return new AttachmentListItem($attachment, $this->out);
122 * widget for displaying a single notice
124 * This widget has the core smarts for showing a single notice: what to display,
125 * where, and under which circumstances. Its key method is show(); this is a recipe
126 * that calls all the other show*() methods to build up a single notice. The
127 * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
128 * author info (since that's implicit by the data in the page).
132 * @author Evan Prodromou <evan@controlyourself.ca>
133 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
134 * @link http://laconi.ca/
136 * @see ProfileNoticeListItem
139 class AttachmentListItem extends Widget
141 /** The attachment this item will show. */
143 var $attachment = null;
150 * Also initializes the profile attribute.
152 * @param Notice $notice The notice we'll display
155 function __construct($attachment, $out=null)
157 parent::__construct($out);
158 $this->attachment = $attachment;
159 $this->oembed = File_oembed::staticGet('file_id', $this->attachment->id);
163 if (empty($this->attachment->title)) {
164 if (empty($this->oembed->title)) {
165 $title = $this->attachment->url;
167 $title = $this->oembed->title;
170 $title = $this->attachment->title;
176 function linkTitle() {
177 return $this->title();
181 * recipe function for displaying a single notice.
183 * This uses all the other methods to correctly display a notice. Override
184 * it or one of the others to fine-tune the output.
192 $this->showNoticeAttachment();
196 function linkAttr() {
197 return array('class' => 'attachment', 'href' => $this->attachment->url, 'id' => 'attachment-' . $this->attachment->id);
200 function showLink() {
201 $this->out->elementStart('a', $this->linkAttr());
202 $this->out->element('span', null, $this->linkTitle());
203 $this->showRepresentation();
204 $this->out->elementEnd('a');
207 function showNoticeAttachment()
212 function showRepresentation() {
213 $thumbnail = File_thumbnail::staticGet('file_id', $this->attachment->id);
214 if (!empty($thumbnail)) {
215 $this->out->element('img', array('alt' => 'nothing to say', 'src' => $thumbnail->url, 'width' => $thumbnail->width, 'height' => $thumbnail->height));
220 * start a single notice.
228 // TODO: add notice_type class e.g., notice_video, notice_image
229 $this->out->elementStart('li');
235 * Close the last elements in the notice list item
242 $this->out->elementEnd('li');
246 class Attachment extends AttachmentListItem
249 $this->showNoticeAttachment();
252 function linkAttr() {
253 return array('class' => 'external', 'href' => $this->attachment->url);
256 function linkTitle() {
257 return $this->attachment->url;
260 function showRepresentation() {
261 if (empty($this->oembed->type)) {
262 if (empty($this->attachment->mimetype)) {
263 $this->out->element('pre', null, 'oh well... not sure how to handle the following: ' . print_r($this->attachment, true));
265 switch ($this->attachment->mimetype) {
270 $this->out->element('img', array('src' => $this->attachment->url, 'alt' => 'alt'));
275 switch ($this->oembed->type) {
279 if (!empty($this->oembed->html)) {
280 $this->out->raw($this->oembed->html);
285 $this->out->element('img', array('src' => $this->oembed->url, 'width' => $this->oembed->width, 'height' => $this->oembed->height, 'alt' => 'alt'));
289 $this->out->element('pre', null, 'oh well... not sure how to handle the following oembed: ' . print_r($this->oembed, true));