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
  44 class RepeatForm extends Form
  45 {
  46     /**
  47      * Notice to repeat
  48      */
  49
  50     var $notice = null;
  51
  52     /**
  53      * Constructor
  54      *
  55      * @param HTMLOutputter $out    output channel
  56      * @param Notice        $notice notice to repeat
  57      */
  58
  59     function __construct($out=null, $notice=null)
  60     {
  61         parent::__construct($out);
  62
  63         $this->notice = $notice;
  64     }
  65
  66     /**
  67      * ID of the form
  68      *
  69      * @return int ID of the form
  70      */
  71
  72     function id()
  73     {
  74         return 'repeat-' . $this->notice->id;
  75     }
  76
  77     /**
  78      * Action of the form
  79      *
  80      * @return string URL of the action
  81      */
  82
  83     function action()
  84     {
  85         return common_local_url('repeat');
  86     }
  87
  88     /**
  89      * Include a session token for CSRF protection
  90      *
  91      * @return void
  92      */
  93
  94     function sessionToken()
  95     {
  96         $this->out->hidden('token-' . $this->notice->id,
  97                            common_session_token());
  98     }
  99
 100     /**
 101      * Legend of the Form
 102      *
 103      * @return void
 104      */
 105     function formLegend()
 106     {
 107         $this->out->element('legend', null, _('Repeat this notice?'));
 108     }
 109
 110     /**
 111      * Data elements
 112      *
 113      * @return void
 114      */
 115
 116     function formData()
 117     {
 118         $this->out->hidden('notice-n'.$this->notice->id,
 119                            $this->notice->id,
 120                            'notice');
 121     }
 122
 123     /**
 124      * Action elements
 125      *
 126      * @return void
 127      */
 128
 129     function formActions()
 130     {
 131         $this->out->submit('repeat-submit-' . $this->notice->id,
 132                            _('Yes'), 'submit', null, _('Repeat this notice'));
 133     }
 134
 135     /**
 136      * Class of the form.
 137      *
 138      * @return string the form's class
 139      */
 140
 141     function formClass()
 142     {
 143         return 'form_repeat';
 144     }
 145 }