]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Favorite/forms/disfavor.php
51903b6cb2d9d61c0f3e0c2bd5e3e9972602199d
[quix0rs-gnu-social.git] / plugins / Favorite / forms / disfavor.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Form for disfavoring 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 disfavoring 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      FavorForm
46  */
47 class DisfavorForm extends Form
48 {
49     /**
50      * Notice to disfavor
51      */
52     var $notice = null;
53
54     /**
55      * Constructor
56      *
57      * @param HTMLOutputter $out    output channel
58      * @param Notice        $notice notice to disfavor
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 'disfavor-' . $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('disfavor');
85     }
86
87     /**
88      * Legend of the Form
89      *
90      * @return void
91      */
92     function formLegend()
93     {
94         // TRANS: Form legend for removing the favourite status for a favourite notice.
95         $this->out->element('legend', null, _('Disfavor this notice'));
96     }
97
98     /**
99      * Data elements
100      *
101      * @return void
102      */
103
104     function formData()
105     {
106         if (Event::handle('StartDisFavorNoticeForm', array($this, $this->notice))) {
107             $this->out->hidden('notice-n'.$this->notice->id,
108                                $this->notice->id,
109                                'notice');
110             Event::handle('EndDisFavorNoticeForm', array($this, $this->notice));
111         }
112     }
113
114     /**
115      * Action elements
116      *
117      * @return void
118      */
119     function formActions()
120     {
121         $this->out->submit('disfavor-submit-' . $this->notice->id,
122                            // TRANS: Button text for removing the favourite status for a favourite notice.
123                            _m('BUTTON','Disfavor favorite'),
124                            'submit',
125                            null,
126                            // TRANS: Button title for removing the favourite status for a favourite notice.
127                            _('Remove this notice from your list of favorite notices.'));
128     }
129
130     /**
131      * Class of the form.
132      *
133      * @return string the form's class
134      */
135     function formClass()
136     {
137         return 'form_disfavor ajax';
138     }
139 }