lib/repeatform.php

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