lib/noticeform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for posting a notice
   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  Form
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2009 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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/form.php';
  36
  37 /**
  38  * Form for posting a notice
  39  *
  40  * Frequently-used form for posting a notice
  41  *
  42  * @category Form
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Sarven Capadisli <csarven@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://status.net/
  48  *
  49  * @see      HTMLOutputter
  50  */
  51
  52 class NoticeForm extends Form
  53 {
  54     /**
  55      * Current action, used for returning to this page.
  56      */
  57
  58     var $action = null;
  59
  60     /**
  61      * Pre-filled content of the form
  62      */
  63
  64     var $content = null;
  65
  66     /**
  67      * The current user
  68      */
  69
  70     var $user = null;
  71
  72     /**
  73      * The notice being replied to
  74      */
  75
  76     var $inreplyto = null;
  77
  78     /**
  79      * Constructor
  80      *
  81      * @param HTMLOutputter $out     output channel
  82      * @param string        $action  action to return to, if any
  83      * @param string        $content content to pre-fill
  84      */
  85
  86     function __construct($out=null, $action=null, $content=null, $user=null, $inreplyto=null)
  87     {
  88         parent::__construct($out);
  89
  90         $this->action  = $action;
  91         $this->content = $content;
  92         $this->inreplyto = $inreplyto;
  93
  94         if ($user) {
  95             $this->user = $user;
  96         } else {
  97             $this->user = common_current_user();
  98         }
  99
 100         if (common_config('attachments', 'uploads')) {
 101             $this->enctype = 'multipart/form-data';
 102         }
 103     }
 104
 105     /**
 106      * ID of the form
 107      *
 108      * @return int ID of the form
 109      */
 110
 111     function id()
 112     {
 113         return 'form_notice';
 114     }
 115
 116     /**
 117      * Action of the form
 118      *
 119      * @return string URL of the action
 120      */
 121
 122     function action()
 123     {
 124         return common_local_url('newnotice');
 125     }
 126
 127     /**
 128      * Legend of the Form
 129      *
 130      * @return void
 131      */
 132     function formLegend()
 133     {
 134         $this->out->element('legend', null, _('Send a notice'));
 135     }
 136
 137     /**
 138      * Data elements
 139      *
 140      * @return void
 141      */
 142
 143     function formData()
 144     {
 145         if (Event::handle('StartShowNoticeFormData', array($this))) {
 146             $this->out->element('label', array('for' => 'notice_data-text'),
 147                                 sprintf(_('What\'s up, %s?'), $this->user->nickname));
 148             // XXX: vary by defined max size
 149             $this->out->element('textarea', array('id' => 'notice_data-text',
 150                                                   'cols' => 35,
 151                                                   'rows' => 4,
 152                                                   'name' => 'status_textarea'),
 153                                 ($this->content) ? $this->content : '');
 154
 155             $contentLimit = Notice::maxContent();
 156
 157             $this->out->element('script', array('type' => 'text/javascript'),
 158                                 'maxLength = ' . $contentLimit . ';');
 159
 160             if ($contentLimit > 0) {
 161                 $this->out->elementStart('dl', 'form_note');
 162                 $this->out->element('dt', null, _('Available characters'));
 163                 $this->out->element('dd', array('id' => 'notice_text-count'),
 164                                     $contentLimit);
 165                 $this->out->elementEnd('dl');
 166             }
 167
 168             if (common_config('attachments', 'uploads')) {
 169                 $this->out->element('label', array('for' => 'notice_data-attach'),_('Attach'));
 170                 $this->out->element('input', array('id' => 'notice_data-attach',
 171                                                    'type' => 'file',
 172                                                    'name' => 'attach',
 173                                                    'title' => _('Attach a file')));
 174                 $this->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
 175             }
 176             if ($this->action) {
 177                 $this->out->hidden('notice_return-to', $this->action, 'returnto');
 178             }
 179             $this->out->hidden('notice_in-reply-to', $this->inreplyto, 'inreplyto');
 180
 181             Event::handle('StartShowNoticeFormData', array($this));
 182         }
 183     }
 184
 185     /**
 186      * Action elements
 187      *
 188      * @return void
 189      */
 190
 191     function formActions()
 192     {
 193         $this->out->element('input', array('id' => 'notice_action-submit',
 194                                            'class' => 'submit',
 195                                            'name' => 'status_submit',
 196                                            'type' => 'submit',
 197                                            'value' => _('Send')));
 198     }
 199 }