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      * Constructor
  74      *
  75      * @param HTMLOutputter $out     output channel
  76      * @param string        $action  action to return to, if any
  77      * @param string        $content content to pre-fill
  78      */
  79
  80     function __construct($out=null, $action=null, $content=null, $user=null)
  81     {
  82         parent::__construct($out);
  83
  84         $this->action  = $action;
  85         $this->content = $content;
  86
  87         if ($user) {
  88             $this->user = $user;
  89         } else {
  90             $this->user = common_current_user();
  91         }
  92
  93         if (common_config('attachments', 'uploads')) {
  94             $this->enctype = 'multipart/form-data';
  95         }
  96     }
  97
  98     /**
  99      * ID of the form
 100      *
 101      * @return int ID of the form
 102      */
 103
 104     function id()
 105     {
 106         return 'form_notice';
 107     }
 108
 109     /**
 110      * Action of the form
 111      *
 112      * @return string URL of the action
 113      */
 114
 115     function action()
 116     {
 117         return common_local_url('newnotice');
 118     }
 119
 120
 121     /**
 122      * Legend of the Form
 123      *
 124      * @return void
 125      */
 126     function formLegend()
 127     {
 128         $this->out->element('legend', null, _('Send a notice'));
 129     }
 130
 131
 132     /**
 133      * Data elements
 134      *
 135      * @return void
 136      */
 137
 138     function formData()
 139     {
 140         $this->out->element('label', array('for' => 'notice_data-text'),
 141                             sprintf(_('What\'s up, %s?'), $this->user->nickname));
 142         // XXX: vary by defined max size
 143         $this->out->element('textarea', array('id' => 'notice_data-text',
 144                                               'cols' => 35,
 145                                               'rows' => 4,
 146                                               'name' => 'status_textarea'),
 147                             ($this->content) ? $this->content : '');
 148         $this->out->elementStart('dl', 'form_note');
 149         $this->out->element('dt', null, _('Available characters'));
 150         $this->out->element('dd', array('id' => 'notice_text-count'),
 151                             '140');
 152         $this->out->elementEnd('dl');
 153         if (common_config('attachments', 'uploads')) {
 154             $this->out->element('label', array('for' => 'notice_data-attach'),_('Attach'));
 155             $this->out->element('input', array('id' => 'notice_data-attach',
 156                                                'type' => 'file',
 157                                                'name' => 'attach',
 158                                                'title' => _('Attach a file')));
 159             $this->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
 160         }
 161         if ($this->action) {
 162             $this->out->hidden('notice_return-to', $this->action, 'returnto');
 163         }
 164         $this->out->hidden('notice_in-reply-to', $this->action, 'inreplyto');
 165     }
 166
 167     /**
 168      * Action elements
 169      *
 170      * @return void
 171      */
 172
 173     function formActions()
 174     {
 175         $this->out->element('input', array('id' => 'notice_action-submit',
 176                                            'class' => 'submit',
 177                                            'name' => 'status_submit',
 178                                            'type' => 'submit',
 179                                            'value' => _('Send')));
 180     }
 181 }