lib/repeatform.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Form for repeating 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  * @copyright 2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Form for repeating a notice
  36  *
  37  * @category Form
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@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 class RepeatForm extends Form
  44 {
  45     /**
  46      * Notice to repeat
  47      */
  48     var $notice = null;
  49
  50     /**
  51      * Constructor
  52      *
  53      * @param HTMLOutputter $out    output channel
  54      * @param Notice        $notice notice to repeat
  55      */
  56     function __construct($out=null, $notice=null)
  57     {
  58         parent::__construct($out);
  59
  60         $this->notice = $notice;
  61     }
  62
  63     /**
  64      * ID of the form
  65      *
  66      * @return int ID of the form
  67      */
  68     function id()
  69     {
  70         return 'repeat-' . $this->notice->id;
  71     }
  72
  73     /**
  74      * Action of the form
  75      *
  76      * @return string URL of the action
  77      */
  78     function action()
  79     {
  80         return common_local_url('repeat');
  81     }
  82
  83     /**
  84      * Include a session token for CSRF protection
  85      *
  86      * @return void
  87      */
  88     function sessionToken()
  89     {
  90         $this->out->hidden('token-' . $this->notice->id,
  91                            common_session_token());
  92     }
  93
  94     /**
  95      * Legend of the Form
  96      *
  97      * @return void
  98      */
  99     function formLegend()
 100     {
 101         // TRANS: For legend for notice repeat form.
 102         $this->out->element('legend', null, _('Repeat this notice?'));
 103     }
 104
 105     /**
 106      * Data elements
 107      *
 108      * @return void
 109      */
 110     function formData()
 111     {
 112         $this->out->hidden('notice-n'.$this->notice->id,
 113                            $this->notice->id,
 114                            'notice');
 115     }
 116
 117     /**
 118      * Action elements
 119      *
 120      * @return void
 121      */
 122     function formActions()
 123     {
 124         $this->out->submit('repeat-submit-' . $this->notice->id,
 125                            // TRANS: Button text to repeat a notice on notice repeat form.
 126                            _m('BUTTON','Yes'), 'submit', null,
 127                            // TRANS: Button title to repeat a notice on notice repeat form.
 128                            _('Repeat this notice.'));
 129     }
 130
 131     /**
 132      * Class of the form.
 133      *
 134      * @return string the form's class
 135      */
 136     function formClass()
 137     {
 138         return 'form_repeat';
 139     }
 140 }