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