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