lib/messageform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for posting a direct message
   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 direct message
  39  *
  40  * @category Form
  41  * @package  StatusNet
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @author   Sarven Capadisli <csarven@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  *
  47  * @see      HTMLOutputter
  48  */
  49
  50 class MessageForm extends Form
  51 {
  52     /**
  53      * User to send a direct message to
  54      */
  55
  56     var $to = null;
  57
  58     /**
  59      * Pre-filled content of the form
  60      */
  61
  62     var $content = null;
  63
  64     /**
  65      * Constructor
  66      *
  67      * @param HTMLOutputter $out     output channel
  68      * @param User          $to      user to send a message to
  69      * @param string        $content content to pre-fill
  70      */
  71
  72     function __construct($out=null, $to=null, $content=null)
  73     {
  74         parent::__construct($out);
  75
  76         $this->to      = $to;
  77         $this->content = $content;
  78     }
  79
  80     /**
  81      * ID of the form
  82      *
  83      * @return string ID of the form
  84      */
  85
  86     function id()
  87     {
  88         return 'form_notice-direct';
  89     }
  90
  91    /**
  92      * Class of the form
  93      *
  94      * @return string class of the form
  95      */
  96
  97     function formClass()
  98     {
  99         return 'form_notice';
 100     }
 101
 102     /**
 103      * Action of the form
 104      *
 105      * @return string URL of the action
 106      */
 107
 108     function action()
 109     {
 110         return common_local_url('newmessage');
 111     }
 112
 113     /**
 114      * Legend of the Form
 115      *
 116      * @return void
 117      */
 118     function formLegend()
 119     {
 120         $this->out->element('legend', null, _('Send a direct notice'));
 121     }
 122
 123     /**
 124      * Data elements
 125      *
 126      * @return void
 127      */
 128
 129     function formData()
 130     {
 131         $user = common_current_user();
 132
 133         $mutual_users = $user->mutuallySubscribedUsers();
 134
 135         $mutual = array();
 136         // TRANS Label entry in drop-down selection box in direct-message inbox/outbox. This is the default entry in the drop-down box, doubling as instructions and a brake against accidental submissions with the first user in the list.
 137         $mutual[0] = _('Select recipient:');
 138
 139         while ($mutual_users->fetch()) {
 140             if ($mutual_users->id != $user->id) {
 141                 $mutual[$mutual_users->id] = $mutual_users->nickname;
 142             }
 143         }
 144
 145         $mutual_users->free();
 146         unset($mutual_users);
 147
 148         if (count($mutual) == 1) {
 149             // TRANS Entry in drop-down selection box in direct-message inbox/outbox when no one is available to message.
 150             $mutual[0] = _('No mutual subscribers.');
 151         }
 152
 153         $this->out->dropdown('to', _('To'), $mutual, null, false,
 154                              ($this->to) ? $this->to->id : null);
 155
 156         $this->out->element('textarea', array('id' => 'notice_data-text',
 157                                               'cols' => 35,
 158                                               'rows' => 4,
 159                                               'name' => 'content'),
 160                             ($this->content) ? $this->content : '');
 161
 162         $contentLimit = Message::maxContent();
 163
 164         if ($contentLimit > 0) {
 165             $this->out->elementStart('dl', 'form_note');
 166             $this->out->element('dt', null, _('Available characters'));
 167             $this->out->element('dd', array('id' => 'notice_text-count'),
 168                                 $contentLimit);
 169             $this->out->elementEnd('dl');
 170         }
 171     }
 172
 173     /**
 174      * Action elements
 175      *
 176      * @return void
 177      */
 178
 179     function formActions()
 180     {
 181         $this->out->element('input', array('id' => 'notice_action-submit',
 182                                            'class' => 'submit',
 183                                            'name' => 'message_send',
 184                                            'type' => 'submit',
 185                                            'value' => _m('Send button for sending notice', 'Send')));
 186     }
 187 }