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 class FavorForm extends Form
  50 {
  51     /**
  52      * Notice to favor
  53      */
  54     var $notice = null;
  55
  56     /**
  57      * Constructor
  58      *
  59      * @param HTMLOutputter $out    output channel
  60      * @param Notice        $notice notice to favor
  61      */
  62     function __construct($out=null, $notice=null)
  63     {
  64         parent::__construct($out);
  65
  66         $this->notice = $notice;
  67     }
  68
  69     /**
  70      * ID of the form
  71      *
  72      * @return int ID of the form
  73      */
  74     function id()
  75     {
  76         return 'favor-' . $this->notice->id;
  77     }
  78
  79     /**
  80      * Action of the form
  81      *
  82      * @return string URL of the action
  83      */
  84     function action()
  85     {
  86         return common_local_url('favor');
  87     }
  88
  89     /**
  90      * Include a session token for CSRF protection
  91      *
  92      * @return void
  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         // TRANS: Form legend for adding the favourite status to a notice.
 108         $this->out->element('legend', null, _('Favor this notice'));
 109     }
 110
 111     /**
 112      * Data elements
 113      *
 114      * @return void
 115      */
 116     function formData()
 117     {
 118         if (Event::handle('StartFavorNoticeForm', array($this, $this->notice))) {
 119             $this->out->hidden('notice-n'.$this->notice->id,
 120                                $this->notice->id,
 121                                'notice');
 122             Event::handle('EndFavorNoticeForm', array($this, $this->notice));
 123         }
 124     }
 125
 126     /**
 127      * Action elements
 128      *
 129      * @return void
 130      */
 131     function formActions()
 132     {
 133         $this->out->submit('favor-submit-' . $this->notice->id,
 134                            // TRANS: Button text for adding the favourite status to a notice.
 135                            _m('BUTTON','Favor'),
 136                            'submit',
 137                            null,
 138                            // TRANS: Button title for adding the favourite status to a notice.
 139                            _('Add this notice to your list of favorite notices.'));
 140     }
 141
 142     /**
 143      * Class of the form.
 144      *
 145      * @return string the form's class
 146      */
 147     function formClass()
 148     {
 149         return 'form_favor ajax';
 150     }
 151 }