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