lib/noticeform.php

   1 <?php
   2 /**
   3  * Laconica, 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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
  26  * @copyright 2009 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!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  Laconica
  44  * @author   Evan Prodromou <evan@controlyourself.ca>
  45  * @author   Sarven Capadisli <csarven@controlyourself.ca>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://laconi.ca/
  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     }
  94
  95     /**
  96      * ID of the form
  97      *
  98      * @return int ID of the form
  99      */
 100
 101     function id()
 102     {
 103         return 'form_notice';
 104     }
 105
 106     /**
 107      * Action of the form
 108      *
 109      * @return string URL of the action
 110      */
 111
 112     function action()
 113     {
 114         return common_local_url('newnotice');
 115     }
 116
 117
 118     /**
 119      * Legend of the Form
 120      *
 121      * @return void
 122      */
 123     function formLegend()
 124     {
 125         $this->out->element('legend', null, _('Send a notice'));
 126     }
 127
 128
 129     /**
 130      * Data elements
 131      *
 132      * @return void
 133      */
 134
 135     function formData()
 136     {
 137         $this->out->element('label', array('for' => 'notice_data-text'),
 138                             sprintf(_('What\'s up, %s?'), $this->user->nickname));
 139         // XXX: vary by defined max size
 140         $this->out->element('textarea', array('id' => 'notice_data-text',
 141                                               'cols' => 35,
 142                                               'rows' => 4,
 143                                               'name' => 'status_textarea'),
 144                             ($this->content) ? $this->content : '');
 145
 146         $this->out->elementStart('dl', 'form_note');
 147         $this->out->element('dt', null, _('Available characters'));
 148         $this->out->element('dd', array('id' => 'notice_text-count'),
 149                             '140');
 150         $this->out->elementEnd('dl');
 151
 152         if ($this->action) {
 153             $this->out->hidden('notice_return-to', $this->action, 'returnto');
 154         }
 155         $this->out->hidden('notice_in-reply-to', $this->action, 'inreplyto');
 156     }
 157
 158     /**
 159      * Action elements
 160      *
 161      * @return void
 162      */
 163
 164     function formActions()
 165     {
 166         $this->out->element('input', array('id' => 'notice_action-submit',
 167                                            'class' => 'submit',
 168                                            'name' => 'status_submit',
 169                                            'type' => 'submit',
 170                                            'value' => _('Send')));
 171     }
 172 }