plugins/Bookmark/bookmarkform.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Form for adding a new bookmark
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Bookmark
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Form to add a new bookmark
  39  *
  40  * @category  Bookmark
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2010 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class BookmarkForm extends Form
  48 {
  49     private $_title       = null;
  50     private $_url         = null;
  51     private $_tags        = null;
  52     private $_description = null;
  53     private $_thumbnail   = null;
  54
  55     /**
  56      * Construct a bookmark form
  57      *
  58      * @param HTMLOutputter $out         output channel
  59      * @param string        $title       Title of the bookmark
  60      * @param string        $url         URL of the bookmark
  61      * @param string        $tags        Tags to show
  62      * @param string        $description Description of the bookmark
  63      *
  64      * @return void
  65      */
  66     function __construct($out=null, $title=null, $url=null, $tags=null,
  67                          $description=null, $thumbnail=null)
  68     {
  69         parent::__construct($out);
  70
  71         $this->_title       = $title;
  72         $this->_url         = $url;
  73         $this->_tags        = $tags;
  74         $this->_description = $description;
  75         $this->_thumbnail   = $thumbnail;
  76     }
  77
  78     /**
  79      * ID of the form
  80      *
  81      * @return int ID of the form
  82      */
  83     function id()
  84     {
  85         return 'form_new_bookmark';
  86     }
  87
  88     /**
  89      * class of the form
  90      *
  91      * @return string class of the form
  92      */
  93     function formClass()
  94     {
  95         return 'form_settings ajax-notice';
  96     }
  97
  98     /**
  99      * Action of the form
 100      *
 101      * @return string URL of the action
 102      */
 103     function action()
 104     {
 105         return common_local_url('newbookmark');
 106     }
 107
 108     /**
 109      * Data elements of the form
 110      *
 111      * @return void
 112      */
 113     function formData()
 114     {
 115         $this->out->elementStart('fieldset', array('id' => 'new_bookmark_data'));
 116         $this->out->elementStart('ul', 'form_data');
 117
 118         $this->li();
 119         $this->out->input('bookmark-url',
 120                           // TRANS: Field label on form for adding a new bookmark.
 121                           _m('LABEL','URL'),
 122                           $this->_url,
 123                           'url');
 124         $this->unli();
 125
 126         list($width, $height) = $this->scaleImage($this->_thumbnail->width,
 127                                                   $this->_thumbnail->height);
 128
 129         if (!empty($this->_thumbnail)) {
 130             $this->out->element('img',
 131                                 array('src' => $this->_thumbnail->url,
 132                                       'width' => $width,
 133                                       'height' => $height));
 134         }
 135
 136         $this->li();
 137         $this->out->input('bookmark-title',
 138                           // TRANS: Field label on form for adding a new bookmark.
 139                           _m('LABEL','Title'),
 140                           $this->_title,
 141                           'title');
 142         $this->unli();
 143
 144         $this->li();
 145         $this->out->textarea('bookmark-description',
 146                              // TRANS: Field label on form for adding a new bookmark.
 147                              _m('LABEL','Notes'),
 148                              $this->_description,
 149                              'description');
 150         $this->unli();
 151
 152         $this->li();
 153         $this->out->input('bookmark-tags',
 154                           // TRANS: Field label on form for adding a new bookmark.
 155                           _m('LABEL','Tags'),
 156                           $this->_tags,
 157                           // TRANS: Field title on form for adding a new bookmark.
 158                           _m('Comma- or space-separated list of tags.'),
 159                           'tags');
 160         $this->unli();
 161
 162         $this->out->elementEnd('ul');
 163
 164         $toWidget = new ToSelector($this->out,
 165                                    common_current_user(),
 166                                    null);
 167         $toWidget->show();
 168
 169         $this->out->elementEnd('fieldset');
 170     }
 171
 172     /**
 173      * Action elements
 174      *
 175      * @return void
 176      */
 177
 178     function formActions()
 179     {
 180         // TRANS: Button text for action to save a new bookmark.
 181         $this->out->submit('submit', _m('BUTTON', 'Save'));
 182     }
 183
 184     function scaleImage($width, $height)
 185     {
 186         $maxwidth = common_config('attachments', 'thumb_width');
 187         $maxheight = common_config('attachments', 'thumb_height');
 188
 189         if ($width > $height && $width > $maxwidth) {
 190             $height = (int) ((((float)$maxwidth)/(float)($width))*(float)$height);
 191             $width = $maxwidth;
 192         } else if ($height > $maxheight) {
 193             $width = (int) ((((float)$maxheight)/(float)($height))*(float)$width);
 194             $height = $maxheight;
 195         }
 196
 197         return array($width, $height);
 198     }
 199 }