Translator documentation added/updated.
[statusnet:mainline.git] / lib / unsubscribeform.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Form for unsubscribing from a user
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 unsubscribing from a user
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      SubscribeForm
48  */
49 class UnsubscribeForm extends Form
50 {
51     /**
52      * Profile of user to unsubscribe from
53      */
54
55     var $profile = null;
56
57     /**
58      * Constructor
59      *
60      * @param HTMLOutputter $out     output channel
61      * @param Profile       $profile profile of user to unsub from
62      */
63     function __construct($out=null, $profile=null)
64     {
65         parent::__construct($out);
66
67         $this->profile = $profile;
68     }
69
70     /**
71      * ID of the form
72      *
73      * @return int ID of the form
74      */
75     function id()
76     {
77         return 'unsubscribe-' . $this->profile->id;
78     }
79
80
81     /**
82      * class of the form
83      *
84      * @return string of the form class
85      */
86     function formClass()
87     {
88         return 'form_user_unsubscribe ajax';
89     }
90
91     /**
92      * Action of the form
93      *
94      * @return string URL of the action
95      */
96     function action()
97     {
98         return common_local_url('unsubscribe');
99     }
100
101     /**
102      * Legend of the Form
103      *
104      * @return void
105      */
106     function formLegend()
107     {
108         // TRANS: Form legend on unsubscribe form.
109         $this->out->element('legend', null, _('Unsubscribe from this user'));
110     }
111
112     /**
113      * Data elements of the form
114      *
115      * @return void
116      */
117     function formData()
118     {
119         $this->out->hidden('unsubscribeto-' . $this->profile->id,
120                            $this->profile->id,
121                            'unsubscribeto');
122     }
123
124     /**
125      * Action elements
126      *
127      * @return void
128      */
129     function formActions()
130     {
131         // TRANS: Button text on unsubscribe form.
132         $this->out->submit('submit', _m('BUTTON','Unsubscribe'), 'submit', null,
133                            // TRANS: Button title on unsubscribe form.
134                            _('Unsubscribe from this user'));
135     }
136 }