lib/favorform.php

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